Any coding scheme that is referenced in the resource, inclulding
the containing scheme itself. Rule: There must be a supportedCodingScheme
entry for each local name in the codingScheme object, with the URN
set to the coding scheme registered name.
True means, one or more entities of this coding scheme is brought
in when the ontology is loaded.
The containing coding
scheme also has its import flag set to true if it has one or more
entities brought in.
False means, loaded
ontology has only references to this coding scheme. Default: true
The local identifier of a supportedCodingScheme that correspondes
with this namespace. In many models, the namespace used to qualify
a concept code has a direct correlation to the coding scheme itself.
If codingSchemeName is present, it asserts that the defining information
about entryCodes in this namespace can be found in the corresponding
coding scheme.
Rule for combining source-specific information such as page numbers,
sections and the like with the source URL. Syntax: [ID] - names the
identifier. Everythinng else is literal.
Class naming.URIMap extends java.lang.Object implements Serializable
Serialized Fields
localId
gov.nih.nci.iso21090.ST localId
An identifier that, in the context of the particular URIMap type,
assigns a meaning to how that property is used. As an example, "en"
might be used to identify English in the context of language.
uri
gov.nih.nci.iso21090.ST uri
A URI that identifies the intended meaning of the localId.
The unique local identifier used to uniquely reference this
coding scheme within the context of a message or container.
codingSchemeName must match a local id of a
supportedCodingScheme in the mappings section.
_codingSchemeURI
java.lang.String _codingSchemeURI
The official URI for this coding scheme . This URI must also
be present in the supportedCodingScheme entry that matches
the codingSchemeName.
_formalName
java.lang.String _formalName
The official or common name by which this coding scheme is
known. (optional)
_defaultLanguage
java.lang.String _defaultLanguage
The local identifier of the language that is used in all
presentations, descriptions, etc. in this coding scheme if
not otherwise specified. defaultLanguage must match a local
id of a supportedLanguage in the mappings section.
_approxNumConcepts
java.lang.Long _approxNumConcepts
The approximate number of entries in the lexical portion of
this scheme. This is used as a hint for browsers and services
_representsVersion
java.lang.String _representsVersion
The specific version of the resource represented by this
coding scheme.
_localNameList
java.util.List<E> _localNameList
Name that can be used to reference the coding scheme within
the context of a given service.
_sourceList
java.util.List<E> _sourceList
The local identifiers of the source(s) of this coding
scheme. Must match a local id of a supportedSource in the
corresponding mappings section.
Information about rights held in and over the resource.
Typically, copyright information includes a statement about
various property rights associated with the resource,
including intellectual property rights.
The local identifier that defines the meaning of this
particular property entry. Must match a local id of a
supportedProperty in the corresponding mappings section.
_propertyId
java.lang.String _propertyId
A unique identifier of this particular
propert/resource/value instance.
_propertyType
java.lang.String _propertyType
The LexGrid model element that this property represents. As
an example, the codingScheme "copyright" attribute could be
represented by a property with a propertyType that mapped to
lgCS:copyRight. Must match a local id of a
supportedPropertyType in the corresponding mappings section.
_language
java.lang.String _language
The local identifier of the language of the property value.
Must match a local id of a supportedLanguage in the
corresponding mappings section. If omitted, and language is
applicable to this property, the defaultLanguage of the
surrounding resource is used.
_sourceList
java.util.List<E> _sourceList
The local identifiers of the source(s) of this property.
Must match a local id of a supportedSource in the
corresponding mappings section.
_usageContextList
java.util.List<E> _usageContextList
The local identifiers of the context(s) in which this
property applies. Must match a local id of a
supportedContext in the corresponding mappings section.
_propertyQualifierList
java.util.List<E> _propertyQualifierList
A qualifier that provides additional information about this
particular property and/or its association with the resource.
The page, subheading, id or other localized information
within the source itself. Used to make a source reference
more precise. Must be absent in supportedSource.
_role
java.lang.String _role
The role or purpose of the the source for this particular
resource (e.g. author, distributor). Must be absent in
supportedSource
The local identifier of the format or data type of the text.
Must match a local id of a supportedDataType in the
corresponding mappings section. Default:
tsCaseSensitiveIA5String
True means that this resource is searchable and browsable if
the temporal context of the operation falls between
effectiveDate and expirationDate. False means that this
resource is only accessible if requested by id or by a
search that specifies that inactive retrievals are allowed.
Default: True
_status
java.lang.String _status
The status code associated with the particular resource. The
semantics and business rules of entryStatus are defined by
the containing system, but there needs to be a mapping into
isActive above.
_effectiveDate
java.util.Date _effectiveDate
The date and time that this resource is considered to be
active. To be considered active, isActive must be true, and
the temporal context of the operation must be greater than
effectiveDate. If omitted, all temporal contexts are
considered to be valid.
_expirationDate
java.util.Date _expirationDate
The date and time that this resource is considered to become
inActive. To be considered active, isActive must be true,
and the temporal context of the operation must be less than
expirationDate. If omitted, all temporal contexts are
considered to be valid.
_owner
java.lang.String _owner
The owner of the resource. The specific semantics of owner
is defined by the busniess rules of the implementor,
including the rules of the owner field is absent.
Local identifier of the namespace of the entityCode.
entityCodeNamespace must match a local id of a
supportedNamespace in the corresponding mappings section. If
omitted, the URI of the defaultCodingScheme will be used as
the namespace for the entity code.
_isAnonymous
java.lang.Boolean _isAnonymous
True means that the entityCode is synthetic, and doesn't
actually exist in the namespace. isAnonymous is used for
synthetic top and bottom nodes as well as blank or anonymous
inner class definitions. Default: False
_isDefined
java.lang.Boolean _isDefined
True means that this entityCode is considered to be
completely defined (i.e. necessary and sufficient) within
the context of the containing code system. False means that
only the necessary components are present. If omitted, the
state of the entityCode definition is not known.
_entityTypeList
java.util.List<E> _entityTypeList
The local identifiers of the entity types(s) represented by
this entity code. Must match a local id of a
supportedEntityType in the corresponding mappings section.
_presentationList
java.util.List<E> _presentationList
The set of presentations for this entityCode that are
defined in the containing coding scheme.
_definitionList
java.util.List<E> _definitionList
The set of definitions for this entityCode that are defined
in the containing coding scheme.
_commentList
java.util.List<E> _commentList
The set of comments for this entityCode that are defined in
the containing coding scheme.
_propertyList
java.util.List<E> _propertyList
The set of properties of this entityCode that are defined in
the containing coding scheme.
_propertyLinkList
java.util.List<E> _propertyLinkList
A link between two properties for the same coded entry.
Example: literal translation of, acronym of
True means that, if the text meets the selection criteria,
it should be the preferred form. For a given language there
should be only one preferred presentation.
_degreeOfFidelity
java.lang.String _degreeOfFidelity
A local identifier that states how closely a term
approximates the intended meaning of an entry code.
degreeOfFidelity must match a local id of a
supportedDegreeOfFidelity in the corresponding mappings
section.
_matchIfNoContext
java.lang.Boolean _matchIfNoContext
True means that this presentation is valid in a acontextual
setting - that it is always valid in the given language.
Default: true if there are no property usageContexts, false
otherwise.
_representationalForm
java.lang.String _representationalForm
A local identifier that states how the term represents the
concept (abbrev, acronym, etc.) representationalForm must
match a local id of a representationalForm in the
corresponding mappings section.
The local name of the type of linke between properties.
propertyLink must match a local id of a
supportedPropertyLink in the corresponding mappings section
_targetProperty
java.lang.String _targetProperty
The identifier of the second property in the link.
True means that the association with
this concept has been explicitly asserted and can be used
for
inferences. False means that the association was asserted
in the other
direction and cannot be used. Default: true
The version of the coding scheme that this entry represents,
if
applicable and known. Note that that is the combination of
the codingSchemeURN
and the version that uniquely represents a coding scheme in
the
system.
_localName
java.lang.String _localName
The short, locally unique name for the coding
scheme.
The registered URI of the associated coding scheme.
_codingSchemeVersion
java.lang.String _codingSchemeVersion
The version of the associated coding scheme. Note that that
is the combination of the codingSchemeURN and the version
that uniquely represents a coding scheme in the system.
_contextList
java.util.List<E> _contextList
Defines 0 or more named contexts for the property .
The list of associations for which the referenced
code acts as the source (lhs, parent, ..) for. If this
element is absent,
no information is available about the target nodes. If the
element is
present, but 0 length, the code does not appear as the
source of
any associations (in the context of the containing graph).
The list of associations for which the referenced
code acts as the target (rhs, child..) for. If this element
is absent,
no information is available about the source nodes. If the
element is
present, but 0 length, the CodedNode doesn't appear as the
target of
any associations (in the context of the containing graph).
True means that the local reference is considered
"complete". The
exact interpretation of this depends upon the element type
- if it is the
localName of a code system, then complete means that all
codes form the
particular version are present. If it is a matching
algorithm, complete means
that all of the codes in the list have been indexed by the
algorithm,
etc.
Status of the coding scheme version within the service
(pending, active, inactive). Note that a pending
deactivation is
identified by the presence of a deactivate date.
_deactivateDate
java.util.Date _deactivateDate
If present, this is that date that this coding scheme is
scheduled to be deactivated (versionStatus = 'pending' or
versionStatus='active') or was actually inactivated
(versionStatus='inactive')
The activity being recorded (create, modify, split, merge,
retire)
_conceptcode
java.lang.String _conceptcode
The unique, permanent, alphanumeric identifier of the concept
_conceptName
java.lang.String _conceptName
The current text name of the concept. Typed as conceptCode
because it serves that function.
_editDate
java.util.Date _editDate
The editDate of the change event.
_referencecode
java.lang.String _referencecode
The identifier for a concept affected by or influencing the
action, as detailed below
_referencename
java.lang.String _referencename
The current text name of the reference concept in all cases
except concept name changes. For
these, the referencename is the old name of the current
concept.
Reference codes are recorded in the following
circumstances:
Merges -
In a merge, two concepts are merged into one. One of the
two concepts survives and the other concept is retired.
A merge history record is written for both of the concepts
with a reference code of the surviving concept and a
retire record is written for the concept that retires. In
the case of A merging with B and A surviving, the history
will appear as follows:
C11111|A|merge|dd-mon-yy|C11111|A
C22222|B|merge|dd-mon-yy|C11111|A
C22222|B|retire|dd-mon-yy|(null)|(null)
Splits -
In a split, a single concept is split into two. The
original concept survives and a new concept is generated.
Two
split records are written for the original concept with
reference codes for the resulting concepts and a create
history
record is written for the new concept. In the case of A
being split into A and B the history will appear as follows:
C22222|B|create|dd-mon-yy|(null)|(null)
C11111|A|split|dd-mon-yy|C22222|B
C11111|A|split|dd-mon-yy|C11111|A
Retires -
In a retirement the concept is moved from it's old location
in the tree hierarchy into the Retired_Kind. A retire
record is written for the retiring concept with a reference
code of the old superconcept. If a concept has multiple
superconcepts, then a retire record is written for each
reference. In the case of retiring concept A which has two
superconcepts (B and C), the history will appear as
follows:
C11111|A|retire|dd-mon-yy|C22222|B
C11111|A|retire|dd-mon-yy|C33333|C
Concept Name Changes -
When a history record is written, the current name of the
concept is recorded in the history. We can match the
conceptcode from the current Thesaurus against the
conceptcodes in the history to determine if any conceptnames
have
changed. In the case of concept A having it's name changed
to B, the history will appear as follows:
C11111|B|modify|dd-mon-yy|(null)|A
The HL7 RIM database contains a compilation of several
individual sources
(e.g. ActClass, ActRole). Each source represents, in
essence, a unique code system
However, the LexBIG HL7 loader is designed to load all RIM
codes to a single LexGrid
coding scheme for convenient load and query. Since there is
only one coding scheme,
metadata for individual RIM sources must be stored
separately. The loader solves this
issue by storing the information to auxiliary metadata
associated with the primary
coding scheme. The auxiliary metadata complies with the
LexGrid CodingSchemes
model definition, with each RIM source represented by an
individual CodingScheme
and using standard LexGrid properties to describe the
additional meta-information
provided by the RIM.
As a convenience to the administrator, the auxiliary
metadata generated by the loader
can optionally be written to a specific file in the local
file system. This preference is
used to specify the location of the reference file. If this
preference is absent, auxiliary
metadata is still generated and assigned to the primary
coding scheme but a temp file is
used. If specified and the file already exists, it is
overwritten. If specified and the file
does not exist, it is created by the loader.
Any xml document can be assigned as metadata to a newly
loaded coding scheme.
The xml document is broken down into individual tags and
values, which are then searchable
through the LexBIG Service Metadata interface. This
parameter indicates the path of
xml metadata assigned during the current load operation.
For most loaders, the given path
serves strictly as an option to input user-specified data.
For some loaders, such as the
HL7 loader and NCI Metathesaurus loader, metadata is
automatically generated and
assigned to the coding scheme. In these cases, the
generated xml will be output to the
given file, overwriting any existing content .
The Metathesaurus distribution contains a compilation of
several individual sources
(e.g. ICD9, MeSH). Each source represents, in essence, a
unique code system
However, the LexBIG Meta loader is designed to load all
Metathesaurus codes to a
single LexGrid coding scheme for convenient load and query.
Since there is only
one coding scheme, metadata for individual sources must be
stored separately.
The loader solves this issue by storing the information to
auxiliary metadata associated
with the primary coding scheme. The auxiliary metadata
complies with the LexGrid
CodingSchemes model definition, with each Metathesaurus
source represented by
an individual CodingScheme and using standard LexGrid
properties to describe the
additional meta-information provided by NIH.
As a convenience to the administrator, the auxiliary
metadata generated by the loader
can optionally be written to a specified file in the local
file system. This preference is
used to specify the location of the reference file. If this
preference is absent, auxiliary
metadata is still generated and assigned to the primary
coding scheme but a temp file is
used If specified and the file already exists, it is
overwritten. If specified and the file
does not exist, it is created by the loader.
Entities can be assigned a property that indicates whether
or not it is
considered primitive (having no equivalent classes). This
preference controls
the name of the property that is created; the property
value will indicate
true or false. If not specified, the name 'primitive' is
assumed.
_propnameType
java.lang.String _propnameType
Anonymous OWL classes of type OWLNAryLogicalClass can be
assigned
properties that indicate the nature or type of component
logical operations.
This preference controls the name of the property that is
created; the
property value will indicate the logical operation (e.g.
owl:oneOf). If not
specified, the name 'type' is assumed.
_matchConceptCode
java.lang.String _matchConceptCode
This preference allows for entity codes to be derived from a
specific RDF
property. The provided string is interpreted as a regular
expression to be
compared against properties assigned to each processed
class. If a
property name matches the regular expression, the property
value
is assigned as the entity code. If not specified no default
match is
assumed, and the entity code is derived from the RDF
resource name.
_matchConceptStatus
java.lang.String _matchConceptStatus
This preference allows for entity status to be derived from
a specific RDF
property. The provided string is interpreted as a regular
expression to be
compared against properties assigned to each processed
class. If a
property name matches the regular expression, the property
value
is assigned as the entity status. If not specified, the
regular expression
of ('concept_status') is assumed, and if not matched no
status string
is assigned (the isActive boolean flag will still be set
based on
deprecation).
_matchNoopNamespaces
java.lang.String _matchNoopNamespaces
This preference allows for classes to be selectively ignored
on import to LexGrid.
The provided string is interpreted as a regular expression
to be compared
against class namespace. If matched, a counterpart entity
is not created in the
LexGrid coding scheme. If not provided, the expression
'(:|@_:|protege:|xsp:).'
is assumed.
_matchRootName
java.lang.String _matchRootName
This preference allows for custom declaration of root
concepts for hierarchical
relationships. The provided string is interpreted as a
regular expression to be
compared against the resource name for each class. If
matched, the node is
designated as a root in the supported hierarchy metadata.
If not specified,
root nodes are identified by having a superclass of
owl:thing.
_matchXMLRepformNames
java.lang.String _matchXMLRepformNames
If processing of complex properties is enabled (see
ProcessComplexProps
preference), this preference allows for identification of
representational form
names contained by XML fragments embedded within rdf
property text.
The provided string is interpreted as a regular expression
and compared
against the XML tags in each fragment. If not specified,
the default
expression '(term-group)' is assumed.
_matchXMLSourceNames
java.lang.String _matchXMLSourceNames
If processing of complex properties is enabled (see
ProcessComplexProps
preference), this preference allows for identification of
source names contained
by XML fragments embedded within rdf property text. The
provided string is
interpreted as a regular expression and compared against
the XML tags in
each fragment. If not specified, the default expression
'(term-source|def-source)'
is assumed.
_matchXMLTextNames
java.lang.String _matchXMLTextNames
If processing of complex properties is enabled (see
ProcessComplexProps
preference), this preference allows for identification of
descriptive text contained
by XML fragments embedded within rdf property text. The
provided string is
interpreted as a regular expression and compared against
the XML tags in
each fragment. If not specified, the default expression
'(term-name|def-definition|go-term)'
is assumed.
_isDBXrefSource
java.lang.Boolean _isDBXrefSource
If processing of complex properties is enabled (see
ProcessComplexProps
preference) and source, this preference allows for
identification of ISBN cross
reference information in xml element text. If not
specified, the default
of 'false' is assumed.
_isDBXrefRepform
java.lang.Boolean _isDBXrefRepform
If processing of complex properties is enabled (see
ProcessComplexProps
preference) and source, this preference allows for
identification of representational
form cross reference information in xml element text. If
not specified, the default
of 'false' is assumed.
_processComplexProps
java.lang.Boolean _processComplexProps
Indicates whether rdf property text will be evaluated to
detect and process
embedded XML. This is a master switch controlling whether
the MatchXML
and isDBXRef preferences are acknowledged. The default is
false.
_strictOWLImplementation
java.lang.Boolean _strictOWLImplementation
Controls the relationship between restrictions of anonymous
classes and parent concepts.
If true, restrictions for anonymous classes are not
connected to the parent concepts.
The default is true.
_createConceptForObjectProp
java.lang.Boolean _createConceptForObjectProp
Controls whether concept entities are created for object
properties defined in
the OWL source. The default is false.
_datatypePropSwitch
java.lang.String _datatypePropSwitch
Controls how data type properties are converted to
components of the LexGrid
model. If 'association' is specified, each data type
property is recorded in LexGrid as
an entity-to-entity relationship. If 'conceptProperty' is
specified, traditional
LexGrid properties are created and assigned directly to new
entities . If 'both'
is specified, both entity relationships and standard
LexGrid entity properties
are generated. The default is 'both'.
Indicates a list of rdf property names to be attributed
special semantic
significance as comments in the LexGrid model. If not
specified, the default
of 'DesignNote, Editor_Note, Citation, and
VA_Workflow_Comment' is
assumed. If not matched, only generic properties are
created.
Indicates a list of rdf property names to be attributed
special semantic
significance as definitions in the LexGrid model. If not
specified, the default
of 'DEFINITION", dDEFINITION, LONG_DEFINITION,
ALT_DEFINITION,
ALT_LONG_DEFINITION, and MeSH_Definition' is assumed.
Indicates a list of rdf property names to be attributed
special semantic
significance as definitions in the LexGrid model. If not
specified, the default
of 'NCI_Preferred_Term, Preferred_Name, Display_Name,
Search_Name,
FULL_SYN, Synonym, VA_Print_Name,
VA_National_Formulary_Name,
VA_Abbreviation, VA_Dose_Form_Print_Name, VA_Trade_Name,
MeSH_Name, NDFRT_Name, RxNorm_Name' is assumed.
The load parameter controls which inherited relationships
are loaded and navigable within
LexBIG. When selecting the option not to load inherited
relationships, all associations
are extracted from the source file SRSTR (stated
relations). When loading all inherited
relations, associations are extracted from the source file
SRSTRE1 (classified relations).
At NCI's request we provided an additional option to load
only stated relations for direct
subclass ('is_a') associations, but inherited relationships
for all other associations.
This was intended to provide similar behavior to their
provision of OWL sources.
Note that direct or stated relationships are always
imported, regardless of the selected
option.
If this flag is set to true, use the localId to check if the
entry already exists. If it exists, update
that entry with the manifest information. If the entry
doesn't exist, add it. If the flag is false, use the localId
to
check it entry already exists. If it doesn't exist, add it.
If it exists, do nothing.
If this flag is 'true', the value provided in the source
file will be replaced with this one.
Otherwise, this value is treated as a default value and
used only if the value is not provided in the source file.
The default value of this is set to 'true'.
If this flag is 'true', the value provided in the source
file will be replaced with this one.
Otherwise, this value is treated as a default value and
used only if the value is not provided in the source file.
The default value of this is set to 'true'.
If this flag is 'true', the value provided in the source
file will be replaced with this one.
Otherwise, this value is treated as a default value and
used only if the value is not provided in the source file.
The default value of this is set to 'true'.
If this flag is 'true', the value provided in the source
file will be replaced with this one.
Otherwise, this value is treated as a default value and
used only if the value is not provided in the source file.
The default value of this is set to 'true'.
If this flag is 'true', the value provided in the source
file will be replaced with this one.
Otherwise, this value is treated as a default value and
used only if the value is not provided in the source file.
The default value of this is set to 'true'.
If this flag is set to true, this value will be added to the
list of values (if not there already).
Otherwise, this value is treated as the default value and
used only if no other value is provided in the source file.
If this flag is set to true, use the localId to check if the
entry already exists. If it exists, update
that entry with the manifest information. If the entry
doesn't exist, add it. If the flag is false, use the localId
to
check it entry already exists. If it doesn't exist, add it.
If it exists, do nothing.
If this flag is set to true, use the localId to check if the
entry already exists. If it exists, update
that entry with the manifest information. If the entry
doesn't exist, add it. If the flag is false, use the localId
to
check it entry already exists. If it doesn't exist, add it.
If it exists, do nothing.
If this flag is 'true', the value provided in the source
file will be replaced with this one.
Otherwise, this value is treated as a default value and
used only if the value is not provided in the source file.
The default value of this is set to 'true'.
If this flag is 'true', the value provided in the source
file will be replaced with this one.
Otherwise, this value is treated as a default value and
used only if the value is not provided in the source file.
The default value of this is set to 'true'.
An association qualifier referenced in the resource
_supportedCodingSchemeList
java.util.List<E> _supportedCodingSchemeList
Any coding scheme that is referenced in the resource,
inclulding the containing scheme itself. Rule: There must be
a supportedCodingScheme entry for each local name in the
codingScheme object, with the URN set to the coding scheme
registered name.
_supportedConceptDomainList
java.util.List<E> _supportedConceptDomainList
Any concept domain that is referenced in the resource.
_supportedContainerNameList
java.util.List<E> _supportedContainerNameList
A relations container that appears in the resource
_supportedContextList
java.util.List<E> _supportedContextList
A context referenced in the resource
_supportedDataTypeList
java.util.List<E> _supportedDataTypeList
A data type referenced by a text element in the resource
_supportedDegreeOfFidelityList
java.util.List<E> _supportedDegreeOfFidelityList
A degree of fidelity referenced in the resource
_supportedEntityTypeList
java.util.List<E> _supportedEntityTypeList
An entityType referenced in the resource
_supportedHierarchyList
java.util.List<E> _supportedHierarchyList
Description of hierarchies used in the resource.
_supportedLanguageList
java.util.List<E> _supportedLanguageList
A language that is referenced in the resource
_supportedNamespaceList
java.util.List<E> _supportedNamespaceList
A namespace that is referenced in the resource
_supportedPropertyList
java.util.List<E> _supportedPropertyList
A property that is referenced in the resource
_supportedPropertyTypeList
java.util.List<E> _supportedPropertyTypeList
A property type that is referenced in the resource
_supportedPropertyLinkList
java.util.List<E> _supportedPropertyLinkList
A property link that is referenced in the resource
_supportedPropertyQualifierList
java.util.List<E> _supportedPropertyQualifierList
A property qualifier that is referenced in the resource
True means, one or more entities of this coding scheme is
brought in when the ontology is loaded.
The containing coding scheme also has its import flag set
to true if it has one or more entities brought in.
False means, loaded ontology has only references to this
coding scheme. Default: true
The local identifier of a supportedCodingScheme that
correspondes with this namespace. In many models, the
namespace used to qualify a concept code has a direct
correlation to the coding scheme itself. If codingSchemeName
is present, it asserts that the defining information about
entryCodes in this namespace can be found in the
corresponding coding scheme.
Rule for combining source-specific information such as page
numbers, sections and the like with the source URL. Syntax:
[ID] - names the identifier. Everythinng else is literal.
An identifier that, in the context of the particular URIMap
type, assigns a meaning to how that property is used. As an
example, "en" might be used to identify English in the
context of language.
_uri
java.lang.String _uri
A URI that identifies the intended meaning of the localId.
The unique identifier assigned to the particular relation,
from, to triple.
_isInferred
java.lang.Boolean _isInferred
True means that this association instance isn't asserted in
the scheme, but is inferred by a classifier. Default: false
_isDefining
java.lang.Boolean _isDefining
True means that this association instance is considered to
be part of the definition of source entity, false means that
it is an "accidental" characteristic. If omitted, this
information is not known.
_usageContextList
java.util.List<E> _usageContextList
The local identifiers of the context(s) in which this
association instance applies. Must match a local id of a
supportedContext in the corresponding mappings section.
_associationQualificationList
java.util.List<E> _associationQualificationList
A set of qualifers that server to modify or qualify this
association instance.
The name or role that the "from" entity plays with respect
to the "to" entry. Should be phrased in terms of the default
language of the association and imply direction.
_reverseName
java.lang.String _reverseName
The name or role that the "to" entity plays with respect to
the "from" entry. Should be phrased in terms of the default
language of the association and imply direction.
_isNavigable
java.lang.Boolean _isNavigable
True means that the reverse direction of the association is
"navigable", meaning that it is makes sense to represent the
target to source side of the association.
_isTransitive
java.lang.Boolean _isTransitive
True means that association is transitive ( r(a,b), r(b,c)
-> r(a,c)). False means not transitive. If absent,
transitivity is unknown or not applicable.
The local identifier of the relation itself. associationName
must match a local id of a supportedAssociationName in the
corresponding mappings section.
_sourceList
java.util.List<E> _sourceList
The "from" set of entities that appear in this relation
Local name of the namespace of the sourceEntityCode.
sourceEntityCodeNamespace must match a local id of a
supportedNamespace in the corresponding mappings section. If
omitted, the URI of sourceEntityCode namespace is the
codingSchemeURI of the containing coding scheme.
_sourceEntityCode
java.lang.String _sourceEntityCode
The entity code of the source entity.
_choiceValue
java.lang.Object _choiceValue
Internal choice value storage
_targetList
java.util.List<E> _targetList
The set of all entities that appear on the "to" (or right
hand) side of a particular relation.
_targetDataList
java.util.List<E> _targetDataList
The set of data instances that appear on the "to" (or right
hand) side of a particular relation.
Local name of the namespace of the targetEntityCode.
targetEntityCodeNamespace must match a local id of a
supportedNamespace in the corresponding mappings section. If
omitted, the URI of targetEntityCode namespace is the
codingSchemeURI of the containing coding scheme.
The unique identifier of this collection. Required if there
is more than one collection of relations in a coding scheme
_representsVersion
java.lang.String _representsVersion
The version of the particular container (mapping) that the
relations entry represents
_isMapping
java.lang.Boolean _isMapping
True means that this set of relations are considered mapping
between sourceCodingScheme and targetCodingScheme.
_sourceCodingScheme
java.lang.String _sourceCodingScheme
Local name of the coding scheme that is used as a source for
this set of relations. sourceCodingScheme must match a local
id of a supportedCodingScheme in the mappings section.
_sourceCodingSchemeVersion
java.lang.String _sourceCodingSchemeVersion
Version of the source coding scheme used in mappings.
_targetCodingScheme
java.lang.String _targetCodingScheme
Local name of the coding scheme that is used as a target for
this set of relations. targetCodingScheme must match a local
id of a supportedCodingScheme in the mappings section.
_targetCodingSchemeVersion
java.lang.String _targetCodingSchemeVersion
Version of the target coding scheme used in mappings.
Information about rights held in and over the resource.
Typically, copyright information includes a statement about
various property rights associated with the resource,
including intellectual property rights.
The local identifier of the language that is used in all
presentations, descriptions, etc. in this coding scheme if
not otherwise specified. defaultLanguage must match a local
id of a supportedLanguage in the mappings section.
_approxNumConcepts
java.lang.Long _approxNumConcepts
The approximate number of entries in the lexical portion of
this scheme. This is used as a hint for browsers and services
The local identifiers of the source(s) of this property.
Must match a local id of a supportedSource in the
corresponding mappings section.
_usageContextList
java.util.List<E> _usageContextList
The local identifiers of the context(s) in which this
property applies. Must match a local id of a
supportedContext in the corresponding mappings section.
_propertyQualifierList
java.util.List<E> _propertyQualifierList
A qualifier that provides additional information about this
particular property and/or its association with the resource.
The local identifier that defines the meaning of this
particular property entry. Must match a local id of a
supportedProperty in the corresponding mappings section.
_propertyId
java.lang.String _propertyId
A unique identifier of this particular
propert/resource/value instance.
The LexGrid model element that this property represents. As
an example, the codingScheme "copyright" attribute could be
represented by a property with a propertyType that mapped to
lgCS:copyRight. Must match a local id of a
supportedPropertyType in the
corresponding mappings section.
The local identifier of the language of the property value.
Must match a local id of a supportedLanguage in the
corresponding mappings section. If omitted, and language is
applicable to this property, the defaultLanguage of the
surrounding resource is
used.
_propertyLinkList
java.util.List<E> _propertyLinkList
A collection of links between this property and another.
The page, subheading, id or other localized information
within the source itself. Used to make a source reference
more precise. Must be absent in supportedSource.
_roleList
java.util.List<E> _roleList
The role or purpose of the the source for this particular
resource (e.g. author, distributor). Must be absent in
supportedSource
The owner of the resource. The specific semantics of owner
is defined by the busniess rules of the implementor,
including the rules of the owner field is absent.
A link to the revision and state change that made this what
it is
_isActive
java.lang.Boolean _isActive
True means that this resource is searchable and browsable if
the temporal context of the operation falls between
effectiveDate and expirationDate. False means that this
resource is only accessible if requested by id or by a
search that specifies that inactive
retrievals are allowed. Default: True
The status code associated with the particular resource. The
semantics and business rules of entryStatus are defined by
the containing system, but there needs to be a mapping into
isActive above.
_effectiveDate
java.util.Date _effectiveDate
The date and time that this resource is considered to be
active. To be considered active, isActive must be true, and
the temporal context of the operation must be greater than
effectiveDate. If omitted, all temporal contexts are
considered to be
valid.
_expirationDate
java.util.Date _expirationDate
The date and time that this resource is considered to become
inActive. To be considered active, isActive must be true,
and the temporal context of the operation must be less than
expirationDate. If omitted, all temporal contexts are
considered to be
valid.
True means that the entityCode is synthetic, and doesn't
actually exist in the namespace. isAnonymous is used for
synthetic top and bottom nodes as well as blank or anonymous
inner class definitions. Default: False
_isDefined
java.lang.Boolean _isDefined
True means that this entityCode is considered to be
completely defined (i.e. necessary and sufficient) within
the context of the containing code system. False means that
only the necessary components are present. If omitted, the
state of the entityCode definition is not known.
True means that, if the text meets the selection criteria,
it should be the preferred form. For a given language there
should be only one preferred presentation.
A local identifier that states how closely a term
approximates the intended meaning of an entry code.
degreeOfFidelity must match a local id of a
supportedDegreeOfFidelity in the corresponding mappings
section.
_matchIfNoContext
java.lang.Boolean _matchIfNoContext
True means that this presentation is valid in a acontextual
setting - that it is always valid in the given language.
Default: true if there are no property usageContexts, false
otherwise.
A local identifier that states how the term represents the
concept (abbrev, acronym, etc.) representationalForm must
match a local id of a representationalForm in the
corresponding mappings section.
An association qualifier referenced in the resource
_supportedCodingSchemeList
java.util.List<E> _supportedCodingSchemeList
Any coding scheme that is referenced in the resource,
inclulding the containing scheme itself. Rule: There must be
a supportedCodingScheme entry for each local name in the
codingScheme object, with the URN set to the coding scheme
registered name.
_supportedContainerList
java.util.List<E> _supportedContainerList
A relations container that appears in the resource
_supportedContextList
java.util.List<E> _supportedContextList
A context referenced in the resource
_supportedDataTypeList
java.util.List<E> _supportedDataTypeList
A data type referenced by a text element in the resource
_supportedDegreeOfFidelityList
java.util.List<E> _supportedDegreeOfFidelityList
A degree of fidelity referenced in the resource
_supportedEntityTypeList
java.util.List<E> _supportedEntityTypeList
An entityType referenced in the resource
_supportedHierarchyList
java.util.List<E> _supportedHierarchyList
Description of hierarchies used in the resource.
_supportedLanguageList
java.util.List<E> _supportedLanguageList
A language that is referenced in the resource
_supportedNamespaceList
java.util.List<E> _supportedNamespaceList
A namespace that is referenced in the resource
_supportedPropertyList
java.util.List<E> _supportedPropertyList
A property that is referenced in the resource
_supportedPropertyTypeList
java.util.List<E> _supportedPropertyTypeList
A property type that is referenced in the resource
_supportedPropertyLinkList
java.util.List<E> _supportedPropertyLinkList
A property link that is referenced in the resource
_supportedPropertyQualifierList
java.util.List<E> _supportedPropertyQualifierList
A property qualifier that is referenced in the resource
True means, one or more entities of this coding scheme is
brought in when the ontology is loaded.
The containing coding scheme also has its import flag set
to true if it has one or more entities brought in.
False means, loaded ontology has only references to this
coding scheme. Default: true
The local identifier of a supportedCodingScheme that
correspondes with this namespace. In many models, the
namespace used to qualify a concept code has a direct
correlation to the coding scheme itself. If codingSchemeName
is present, it asserts that the defining information about
entryCodes in this namespace can be found in the
corresponding coding scheme.
Rule for combining source-specific information such as page
numbers, sections and the like with the source URL. Syntax:
[ID] - names the identifier. Everythinng else is literal.
An identifier that, in the context of the particular URIMap
type, assigns a meaning to how that property is used. As an
example, "en" might be used to identify English in the
context of language.
_uri
java.lang.String _uri
A URI that identifies the intended meaning of the localId.
True means that this association instance isn't asserted in
the scheme, but is inferred by a classifier. Default: false
_isDefining
java.lang.Boolean _isDefining
True means that this association instance is considered to
be part of the definition of source entity, false means that
it is an "accidental" characteristic. If omitted, this
information is not known.
_idIsPublic
java.lang.Boolean _idIsPublic
True means that the association instance identifier was
assigned by the resource authors. False means that it was
internally generated and cannot be used for identification
purposes
_associationInstanceId
java.lang.String _associationInstanceId
The unique identifier assigned to the particular relation,
from, to triple.
_usageContextList
java.util.List<E> _usageContextList
The local identifiers of the context(s) in which this
association instance applies. Must match a local id of a
supportedContext in the corresponding mappings section.
_associationQualificationList
java.util.List<E> _associationQualificationList
A set of qualifers that server to modify or qualify this
association instance.
The local identifier of an association that appears in the
native relations collection in the default coding scheme.
This association is used to describe a set of entity codes.
If absent, only the entityCode itself is included in this
definition.
_transitiveClosure
java.lang.Boolean _transitiveClosure
If true and referenceAssociation is supplied and
referenceAssociation is defined as transitive, include all
entity codes that belong to transitive closure of
referenceAssociation as applied to entity code. Default: fals
_leafOnly
java.lang.Boolean _leafOnly
If true and referenceAssociation is supplied and
referenceAssociation is defined as transitive, include all
entity codes that are "leaves" in transitive closure of
referenceAssociation as applied to entity code. Default: fals
_targetToSource
java.lang.Boolean _targetToSource
If true and referenceAssociation is supplied, navigate from
entityCode as the association target to the corresponding
sources. If transitiveClosure is true and the
referenceAssociation is transitive, include all the
ancestors in the list rather than just the direct "parents"
(sources).
The mappings that are specific to this pick list definition.
This set of mappings must be supplied when a pick list
definition is included in a changedEntry and must be empty
when it is included in a pickLists collection, as the
collection itself carries the mappings
_pickListEntryNodeList
java.util.List<E> _pickListEntryNodeList
An entry in the list
_sourceList
java.util.List<E> _sourceList
The local identifiers of the source(s) of this pick list
definition. Must match a local id of a supportedSource in
the corresponding mappings section.
_defaultPickContextList
java.util.List<E> _defaultPickContextList
The local identifiers of the context used in the definition
of the pick list.
Local name of the namespace to which the entry codes in this
list belong. defaultEntityCodeNamespace must match a local
id of a supportedNamespace in the mappings section.
The local identifier of the language that is used to
generate the text of this pick list if not otherwise
specified. Note that this language does NOT necessarily have
any coorelation with the language of a pickListEntry itself
or the language of the target user. defaultLanguage must
match a local id of a supportedLanguage in the mappings
section.
The local identifier of a sort order that is used as the
default in the definition of the pick list
_completeDomain
java.lang.Boolean _completeDomain
True means that this pick list should represent all of the
entries in the domain. Any active entity codes that aren't
in the specific pick list entries are added to the end,
using the designations identified by the defaultLanguage,
defaultSortOrder and defaultPickContext. Default: false
The text that represents this node in the pick list. Some
business rules may require that this string match a
presentation associated with the entityCode
_pickContextList
java.util.List<E> _pickContextList
The local identifiers of the context(s) in which this entry
applies. pickContext must match a local id of a
supportedContext in the mappings section
_entryOrder
java.lang.Long _entryOrder
Relative order of this entry in the list. pickListEntries
without a supplied order follow the all entries with an
order, and the order is not defined.
Local identifier of the namespace of the entity code if
different than the pickListDefinition
defaultEntityCodeNamespace. entityCodeNamespace must match a
local id of a supportedNamespace in the mappings section.
The property identifier associated with the entityCode and
entityCodeNamespace that the pickText was derived from. If
absent, the pick text can be anything. Some terminologies
may have business rules requiring this attribute to be
present.
_isDefault
java.lang.Boolean _isDefault
True means that this is the default entry for the supplied
language and context.
_matchIfNoContext
java.lang.Boolean _matchIfNoContext
True means that this entry can be used if no contexts are
supplied, even though pickContext ispresent.
The local name of the language to be used when the
application/user supplies a selection language matches. If
absent, this matches all languages. language must match a
local id od of a supportedLanguage in the mappings section.
Local identifier of the namespace of the entity code if
different than the pickListDefinition
defaultEntityCodeNamespace. entityCodeNamespace must match a
local id of a supportedNamespace in the mappings section.
The local identifiers of the source(s) of this property.
Must match a local id of a supportedSource in the
corresponding mappings section.
_representsRealmOrContextList
java.util.List<E> _representsRealmOrContextList
The local identifiers of the context(s) in which this value
domain applies. Must match a local id of a supportedContext
in the corresponding mappings section.
Local name of the primary coding scheme from which the
domain is drawn. defaultCodingScheme must match a local id
of a supportedCodingScheme in the mappings section.
_definitionEntryList
java.util.List<E> _definitionEntryList
A portion of the value domain definition. Definition entries
are ordered.
The local identifiers of the source(s) that participated in
this particular change. changeAgent must match a local id of
a supportedSource in the corresponding mappings section.
A collection of pick list definitions that are included in
this release. Each entry in this collection is a complete
representation of a pick list definition at a given revision.
The local identifier of the coding scheme that the entity
codes are drawn from . codingSchemeName must match a local
id of a supportedCodingScheme in the mappings section.
Local identifier of the namespace of the entityCode.
entityCodeNamespace must match a local id of a
supportedNamespace in the corresponding mappings section. If
omitted, the URI of the defaultCodingScheme will be used as
the URI of the entity code.
_referenceAssociation
java.lang.String _referenceAssociation
The local identifier of an association that appears in the
native relations collection in the default coding scheme.
This association is used to describe a set of entity codes.
If absent, only the entityCode itself is included in this
definition.
_transitiveClosure
java.lang.Boolean _transitiveClosure
If true and referenceAssociation is supplied and
referenceAssociation is defined as transitive, include all
entity codes that belong to transitive closure of
referenceAssociation as applied to entity code. Default: fals
_leafOnly
java.lang.Boolean _leafOnly
If true and referenceAssociation is supplied and
referenceAssociation is defined as transitive, include all
entity codes that are "leaves" in transitive closure of
referenceAssociation as applied to entity code. Default: fals
_targetToSource
java.lang.Boolean _targetToSource
If true and referenceAssociation is supplied, navigate from
entityCode as the association target to the corresponding
sources. If transitiveClosure is true and the
referenceAssociation is transitive, include all the
ancestors in the list rather than just the direct "parents"
(sources).
An identifier that uniquely names this list within the
context of the collection.
_representsValueSetDefinition
java.lang.String _representsValueSetDefinition
The URI of the value set definition that is represented by
this pick list
_defaultEntityCodeNamespace
java.lang.String _defaultEntityCodeNamespace
Local name of the namespace to which the entry codes in this
list belong. defaultEntityCodeNamespace must match a local
id of a supportedNamespace in the mappings section.
_defaultLanguage
java.lang.String _defaultLanguage
The local identifier of the language that is used to
generate the text of this pick list if not otherwise
specified. Note that this language does NOT necessarily have
any coorelation with the language of a pickListEntry itself
or the language of the target user. defaultLanguage must
match a local id of a supportedLanguage in the mappings
section.
_defaultSortOrder
java.lang.String _defaultSortOrder
The local identifier of a sort order that is used as the
default in the definition of the pick list
_completeSet
java.lang.Boolean _completeSet
True means that this pick list should represent all of the
entries in the value set definition. Any active entity codes
that aren't in the specific pick list entries are added to
the end, using the designations identified by the
defaultLanguage, defaultSortOrder and defaultPickContext.
Default: false
The mappings that are specific to this pick list definition.
This set of mappings must be supplied when a pick list
definition is included in a changedEntry and must be empty
when it is included in a pickLists collection, as the
collection itself carries the mappings
_pickListEntryNodeList
java.util.List<E> _pickListEntryNodeList
An entry in the list
_sourceList
java.util.List<E> _sourceList
The local identifiers of the source(s) of this pick list
definition. Must match a local id of a supportedSource in
the corresponding mappings section.
_defaultPickContextList
java.util.List<E> _defaultPickContextList
The local identifiers of the context used in the definition
of the pick list.
Relative order of this entry in the list. pickListEntries
without a supplied order follow the all entries with an
order, and the order is not defined.
_entityCode
java.lang.String _entityCode
Entity code associated with this entry.
_entityCodeNamespace
java.lang.String _entityCodeNamespace
Local identifier of the namespace of the entity code if
different than the pickListDefinition
defaultEntityCodeNamespace. entityCodeNamespace must match a
local id of a supportedNamespace in the mappings section.
_propertyId
java.lang.String _propertyId
The property identifier associated with the entityCode and
entityCodeNamespace that the pickText was derived from. If
absent, the pick text can be anything. Some terminologies
may have business rules requiring this attribute to be
present.
_isDefault
java.lang.Boolean _isDefault
True means that this is the default entry for the supplied
language and context.
_matchIfNoContext
java.lang.Boolean _matchIfNoContext
True means that this entry can be used if no contexts are
supplied, even though pickContext ispresent.
_language
java.lang.String _language
The local name of the language to be used when the
application/user supplies a selection language matches. If
absent, this matches all languages. language must match a
local id od of a supportedLanguage in the mappings section.
_pickText
java.lang.String _pickText
The text that represents this node in the pick list. Some
business rules may require that this string match a
presentation associated with the entityCode
_pickContextList
java.util.List<E> _pickContextList
The local identifiers of the context(s) in which this entry
applies. pickContext must match a local id of a
supportedContext in the mappings section
Local identifier of the namespace of the entity code if
different than the pickListDefinition
defaultEntityCodeNamespace. entityCodeNamespace must match a
local id of a supportedNamespace in the mappings section.
The local identifier of the codingScheme that this
propertyreference will be resolved against. codingScheme
must match a local id of a supportedCodingscheme in the
corresponding mappings section.
_propertyName
java.lang.String _propertyName
The local identifier to be used to restrict the entities to
have property with this name. Must match a local id of a
supportedProperty in the corresponding mappings section.
Local name of the primary coding scheme from which the value
set is drawn. defaultCodingScheme must match a local id of a
supportedCodingScheme in the mappings section.
_conceptDomain
java.lang.String _conceptDomain
The local name of the concept domain this value set
definition binds to. conceptDomain must match a local id of
a supportedConceptDomain in the mappings section.
The mappings that are specific to this value set definition.
This set of mappings must be supplied when a value set
definition is included in a changedEntry and must be empty
when it is included in a valueSets collection, as the
collection itself carries the mappings
_sourceList
java.util.List<E> _sourceList
The local identifiers of the source(s) of this property.
Must match a local id of a supportedSource in the
corresponding mappings section.
_representsRealmOrContextList
java.util.List<E> _representsRealmOrContextList
The local identifiers of the context(s) in which this value
set definition applies. Must match a local id of a
supportedContext in the corresponding mappings section.
The URI of the value set definition to apply the operator
to. This value set definition may be contained within the
local service or may need to be resolved externally.
The end date for which this version is operative (considered
commited).
_editOrder
java.lang.Long _editOrder
The relative order that this revision is to be applied if in
a systemRelease.
_changeAgent
java.lang.String _changeAgent
The local identifiers of the source(s) that participated in
this particular change. changeAgent must match a local id of
a supportedSource in the corresponding mappings section.
A collection of coding schemes that are included in this
release. Each entry in this collection is a complete
representation of a coding scheme at a given revision.
A collection of pick list definitions that are included in
this release. Each entry in this collection is a complete
representation of a pick list definition at a given revision.
Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.