A choice of the possible types of entity description
PSM
A choice of the possible types of entity description
PSM
The attributes common to both named and anonymous entity descriptions. EntityDescriptionBase is an abstract class and cannot be directly instantiated.
the local namespace name and entity name that, together, uniquely name this referenced within the context of a CTS2 service instance. As an example, a service instance may choose to designate
the entity referenced by the about URI of http://www.w3.org/TR/2003/PR-owl-guide-20031209/wine#CabernetSauvignon with the namespaceName "wine" and the name "CabernetSauvignon".The name
portion of ScopedEntityName must uniquely name the particular entity within the context of the code system version.
alternative unique identifiers that reference the about entity in the context of describing code system version. The namespace names the context from which the name (or code) is derived.
Note that it is possible for the entityId name and/or one more alternateEntityId
names to be represented in the designation attribute as well. This would occur when the name serves a dual role of unique identifier and human readable label. An example of
alternateEntityId would be the SNOMED-CT fully specified name, which serves as a unique identifier in human readable form. This might or might not also be considered a designation depending on the context
and use case. Similarly, the SNOMED-CT Clinical Terms V3 Identifier (CTV3) and SNOMED-3 identifiers would appear here as well, as would the HL7's case sensitive and case insensitive unit of measure
identifiers.
a reference to the version of an ontology or code system that makes the set of assertions contained in this description. Note that this references the "asserting", not the "containing" code system
version. As an example, the Wine Ontology imports the Food Ontology, which, in turn contains descriptions of PotableLiquid. A service that represented a (version of) the Wine Ontology would contain an entity
description about "http://www.w3.org/TR/2003/PR-owl-guide-20031209/food#PotableLiquid" (namespaceName: food, name: PotableLiquid). The describingCodeSystemVersion, however, would be
"http://www.w3.org/TR/2003/PR-owl-guide-20031209/wine#" even though this entity was described in the food ontology. Note also that it both the food and wine ontology were represented in a service, the service would
contain two entity descriptions - one from the food ontology perspective and one from the wine ontology perspective.
a "string of (UNICODE) characters ... in a given natural language, such as English or Japanese." A designation provides the
strongest clues as to the meaning of a class, predicate or individual. While designations are not mandatory in an entity description, as all that may be available to a service is a code, service implementers are
strongly encouraged to provide at least one preferred or alternate designation to make the description visible to text search engines.
an explanation of the intended meaning of a concept. An EntityDescription may have multiple definitions, each derived from a different source, represented in a different language or having
a different purpose. Definitions apply only to classes and predicates, not individuals.
an example of an instance or instances of the referenced entity, typically written for human consumption. Examples apply only to classes and predicates, not individuals.
a note or comment about the history, status, use or other descriptions about the EntityDescription. Observe that note, as used in the CTS2 specification, does include examples
or definitions.
additional "non-semantic" (annotation) assertions about the entity being described that do not fit into the designation, definition, note, or example or entityId
categories.
a DirectoryURI that resolves to the list of statements that were used in the assembly of this description. Statements need only be present in service instances that support the
Statement profile, and serves as a bridge between atomic structure contained in the source resource and the CTS2 rendering.
an AssociationDirectoryURI that resolves to a list of active associations ("semantic" assertions) in which the about entity appears as a subject and that are assertedBy the
describingCodeSystemVersion. subjectOf is only included in an EntityDescription when resolution would yield at least one result. This attribute will only be present in CTS2 service
implementations that support the ASSOCIATION QUERY profile.
a DirectoryURI that resolves to the list of active associations ("semantic" assertions) in which the about entity appears as a predicate and that are assertedBy the
describingCodeSystemVersion. predicateOf is only included in an EntityDescription when resolution would yield at least one result. This attribute will only be present in CTS2
service implementations that support the ASSOCIATION QUERY profile.
a DirectoryURI that resolves to the list of active associations ("semantic" assertions) in which the about entity appears as either a direct target or the target of a contained BNode and
that are assertedBy the describingCodeSystemVersion. targetOf is only included in an EntityDescription when resolution would yield at least one result. This attribute will only be present
in CTS2 service implementations that support the ASSOCIATION QUERY profile.
the set of direct "parents" asserted by describingCodeSystemVersion. It is the responsibility of the service to determine what predicate(s) represent "parent/child" relationships. Typically
"parent" is associated with "rdfs:subClassOf" in the OWL/RDF world and skos:broader/skos:narrower in the SKOS environment. It is possible, however for some code systems to have other relationships as well. As an
example, some of the Open Biomedical Ontologies (OBO) use a mixture of subClassOf and partOf relationships.
a DirectoryURI that resolves to the list of direct "parents" asserted by describingCodeSystemVersion. This returns the
parent elements above.
a DirectoryURI that resolves to the transitive closure of the "parents" relationship(s). The primary purpose for this attribute is to provide a handle for subsumption queries. As an example, to
determine whether Class X was a subclass of Class Y, one would query whether the EntityReference to Y was a member of X.ancestors.
a DirectoryURI that resolves to the list of direct "children" asserted by describingCodeSystemVersion. As with parent, it is the responsibility of the service to determine what
predicate(s) represent "parent/child" relationships. children may also include entity references that appear in the target of bnodes if they are determined to be such by the service.
a DirectoryURI that resolves to the transitive closure of the "children" relationship(s). The primary purpose for this attribute is to provide a handle for subsumption queries. As an example, a
second way to determine whether Class X was a subclass of Class Y, one would query whether the EntityReference to X was a member of Y.descendants.
the set of type(s) which the entityReference is an instance of. Because this is a terminology service, entityType must include one of owl:class, owl:individual, rdf:predicate or skos:concept,
although it may carry many other types as well.
a DirectoryURI that resolves to the list of entities that asserted to be instances of the type represented by about URI. This element is present only if resolution will return a non-empty
set.
an entity that has been determined to be equivalent to the about entity in the context of the assertions made by describingCodeSystemVersion.
the URI that represents the entity (class, predicate and/or individual) referenced by this EntityDescription
about is a PersistentURI when entityDescriptionType is NAMED_ENTITY_DESCRIPTION and LocalURI when entityDescriptionType is ANONYMOUS_ENTITY_DESCRIPTION
If present, identifies the role that the code system plays in the description
of the entity. If absent, the role is unknown.
An entity description that is referenced by a globally unique external URI
An entity description that is local to a given code system version. Anonymous entity descriptions are not changeable and have no external URI
A Designation is identical to a Lexical Label as defined in SKOS. It is a "string of
(UNICODE) characters ... in a given natural language, such as English or Japanese." "These labels provide the strongest clues as to the meaning of a (SKOS concept)". The CTS2 specification generalizes the label
use to include not only SKOS concepts but any class, predicate or individual - collectively referred to as Entity. Note that Designation is intended only for identifiers that are interpreted by human beings.
Numeric codes and other machine readable identifiers should be recorded as ScopedEntityNames.
the context(s) in which this designation is applicable
the type of designation (e.g. abbreviation, eponym, short name, long name, etc.) of the given designation.
identifies the significance that case plays in the value of this particular designation.
a measure of how closely this designation actually matches the intended meaning of the target entity. Typical values might represent "exact", "approximate", "broader", "narrower",
etc.
an indicator that determines the particular role that this designation plays
the code system version that contains the assertion(s) represented in the Note
an identifier that is assigned to this designation / entity pair by the authoring body. As an example this would carry the SCTID for SNOMED-CT concepts.
a URI that, when de-referenced, provides the equivalent Statement that forms this designation. This is only present when the Statement profile is supported by the implementing
service.
The role that a designation plays in respect to the referenced Entity. DesignationRole is intended to convey the same semantics as the three types of SKOS Label - skos:prefLabel (PREFERRED), skos:altLabel (ALTERNATIVE) and skos:hiddenLabel (HIDDEN). The SKOS consistency rules with respect to
preferred labels also apply to designation with two exceptions:(1) There can be more than one preferred label for the same language if the usageContext is different(2) If the service implementation supports structured
data, it is possible to have more than one preferred label for the same language and context as long as each has a different format.
The preferred human-readable representation of the entity in a given language, context (aka. domain in SKOS terms) and format. PREFERRED is equivalent to skos:prefLabel.
The acceptable alternative human-readable representation of the entity in a given language, context (aka. domain in SKOS terms) and format. The term "synonym" is often used to indicate an alternate
designation although strictly speaking, "synonym" is a term-term relationship. ALTERNATIVE is equivalent to skos:altLabel
The designation may be used to represent the entity under certain circumstances, but it is not normally displayed. Hidden designations are used primarily for search terms and typically represent common
misspellings or deprecated usages. HIDDEN is equivalent to skos:hiddenLabel
the description of an entity that is a Class, Type or "Concept". "Classes can be understood as sets of
individuals".
the specific role that the class description plays, if known.
an indicator that states whether the class description contains only necessary assertions (PRIMITIVE) or is considered to be both necessary and sufficient assertions
(FULLY_DEFINED).
the type, from a description logic perspective, of a class description
an atomic class description
a complex class description
a class that represents the set of all individuals in the domain of discourse represented by the containing code system or ontology
a class that represents the set that contains no individuals in the context of the containing domain or ontology
determines whether a class description is considered to consist of necessary or necessary and sufficient definitions of the member individuals
The defining assertions of the class description are necessary for all individuals that are members of the class. If an individual is asserted to be a member of the class, it can be asserted that it
possesses all of the defining characteristics.
The defining assertions of the class description are both necessary and sufficient. If an individual is asserted to be a member of the class, it can be asserted that it possesses all of the defining
characteristics and, if an individual is determined to possess all of the defining characteristics in the class definition, it can be asserted to be a member of the class.
a description of an individual that has identity
an "intensional" description of an individual that describes the individual by its characteristics without supplying its identity. As an example, the description "The sole occupant of 773 Main Street in Sioux
City, South Dakota" would reference an anonymous individual."If an individual is not expected to be used outside a particular ontology, one can use an anonymous individual, which is identified by a local node ID rather than
a global IRI. Anonymous individuals are analogous to blank nodes in RDF" http://www.w3.org/TR/owl2-syntax/#Anonymous_Individuals
ahe description of a data type, which, in this context, represents a constraint on the set of possible values in a text or literal field. "Datatypes are entities that refer to sets of data values."
PredicateDescription covers the spectrum of entities deemed "Role" in description logic, "Relation" in predicate logic, "Property" in RDF and OWL, and "Association" in Ontylog DL. It describes the nature
and the purpose of the role, not the individual elements.Note that section 2.4.2.11 of the HL7 SFM calls for an attribute called "associationKind". While we are not absolutely certain what this was intended to represent, we
believe that its intent is probably subsumed under the various individual types as well as the transitivity attribute. forwardName and reverseName are called for in the SFM. The way that they are represented in
this model lacks the ability to represent them in a multi-lingual environment which may cause difficulties down the line. Service implementers who are concerned about this aspect are encouraged to extend the service to allow
forward and reverse Name to be returned in the language appropriate to the service viewer.The directed attribute is actually more of a characteristic of the type of logic being used than the individual properties, but
returning it as an attribute of a property seems sufficient.The HL7 SFM ruleSetId construct is not supported in this specification.
the name assigned to the predicate when applied in the source to target direction. The primary purpose of this attribute is to provide some notion of "directional" semantics, as predicates named
"part" or "broader term" often lack sufficient information to understand where the whole or broader component goes. Implementers will note that, as opposed to official designations, forwardName and
reverseName are not keyed by language. Implementers are encouraged to develop designations and use the forwardName and reverseName tags if a richer model is
desired.
the name assigned to the predicate when applied in the target to source direction. The primary purpose of this attribute is to provide some notion of "directional" semantics, as predicates named
"part" or "broader term" often lack sufficient information to understand where the whole or broader component goes.
A PredicateDescription that describes a predicate used for "lexical" annotation of an entity or other resource. Annotation properties are "semantically weak" (see below) in the sense that they are not
inherited through subclass associations."For annotations properties note that annotations are not 'semantic-free' under the OWL 2 RDF-Based Semantics. Just like every other triple or set of triples occurring in an RDF graph,
an annotation is assigned a truth value by any given OWL 2 RDF-Based interpretation. Hence, although annotations are meant to be 'semantically weak', i.e., their formal meaning does not significantly exceed that originating
from the RDF Semantics specification, adding an annotation may still change the meaning of an ontology."
http://www.w3.org/TR/2009/REC-owl2-rdf-based-semantics-20091027/#Introduction_.28Informative.29
A PredicateDescription whose domain is a set of literals."Data properties connect individuals with literals. In some knowledge representation systems, functional data properties are called attributes."
http://www.w3.org/TR/owl2-syntax/#Data_Properties
the description of a "semantic" predicate. "Object properties connect pairs of individuals."
an indicator that states whether the object property is unidirectional (i.e. requires an inverse to be explicitly declared) or is bidirectional.
transitivity characteristics of the property. If not supplied, transitivity characteristics are either unknown or not applicable (i.e. $domain \cup range = \emptyset$)
an indicator that determines whether an object property is considered to be transitive
asserts $\forall a, b, c : C @ p(a,b) \land p(b, c) \implies p(a,c)$
asserts $\forall a, b, c : C @ \lnot(p(a,b) \land p(b, c) \implies p(a,c))$
asserts $\forall a, b, c : C @ p(a,b) \land p(b, c) \implies \lnot p(a,c)$
indicates whether the semantics of an object property are unidirectional (i.e. $\lnot r(a,b) \implies r(b,a)$ or bidirectional ($r(a,b) \implies r(b,a)$).
$\lnot r(a,b) \implies r(b,a)$
$r(a,b) \implies r(b,a)$
An EntityDescription as returned from a service
PSM
An EntityReference as returned from a service
PSM
a directory of Entity resources that meet a specified criteria
A synopsis of an Entity along with information about how to access the complete resource.
a collection of complete Entity resources that meet a specified criteria
An instance of Entity that meets a specified filter criteria.