Message structure for packaging and sending complex queries.
A Query may contain a Filter, a Set Operation, or Both.
PSM
The match algorithm of the filter to be applied. If a 'setOperation' is specified,
the filter will apply to the resulting aggregate.
The match value of the filter to be applied. If a 'setOperation' is specified,
the filter will apply to the resulting aggregate.
The target components of the filter to be applied. If a 'setOperation' is specified,
the filter will apply to the resulting aggregate.
The Set Operation to be applied to the two DirectoryURIs.
Either a 'DirectoryURI' or a 'Query' may participate in a Set Operation.
The left-hand side of the Set Operation.
The left-hand side of the Set Operation.
Either a 'DirectoryURI' or a 'Query' may participate in a Set Operation.
The right-hand side of the Set Operation.
The right-hand side of the Set Operation.
The CTS2 specification defines eleven distinct structural profiles. CTS2 compliant implementations may elect to implement any combination of these profiles to meet their individual requirements and use cases.
The CODE_SYSTEM profile provides a catalog of classification systems, code systems, ontologies, thesauri, etc. known to the service and may also carry information about their publisher, release cycles, purpose, etc.
The CODE_SYSTEM_VERSION profile carries information about the various versions of a code system, including when the release date, release format, contact information, etc.
The ENTITY DESCRIPTION profile provides a representation of a collection of descriptions about classes, roles or individuals along with links to the code system version(s) in which these descriptions originate. An entity description provides the "lexical" or "non-semantic" components of a description, while the ASSOCIATION profile provides the logic-based "semantic" counterpart.The service supports the EntityDescription structural
model, which means that it can represent sets of lexical assertions about classes, roles and/or individuals as asserted by a specific code system version
The ASSOCIATION profile represents a collection of structured, "semantic" assertions about classes, roles and/or individuals along with links to the code system version(s) that were the source of these assertions.The service supports the Association structural model, which means that it can represent sets of semantic assertions about classes, roles and/or individuals as asserted by a specific code system version
The VALUE_SET profile provides a catalog of value sets that are known to the service along with information about their publisher, release cycles, purpose, etc. Note that "Value Set" in this context represents an abstraction (e.g. the HL7 Administrative Gender Value Set, the SNOMED-CT core anatomic types) that may be coupled with different sets of possible values at different periods in time.
The VALUE_SET_DEFINITION structural profile provides definitions that, when interpreted using specified code system versions, result in a set of entity descriptions. Definitions are associated with value sets and can vary and evolve over time.
The VALUE_SET_RESOLUTION profile describes rules for ordering and associating additional properties with the result of interpreting a value set definition. VALUE_SET_RESOLUTION allows resolved definitions to be rendered in a given language and context, sorted and filtered.
A CONCEPT_DOMAIN profile describes the equivalent of a 11179 Data Element Concept. It identifies an abstract unit of information that can appear on a message, form or database along with metadata about its use, author, purpose, etc.
A CONCEPT_DOMAIN_BINDING profile describes the equivalent of the 11179 Data Element, associating a CONCEPT_DOMAIN with a value set and describing the context and rules where the association applies.
The MAP profile defines collections of rules for transforming information represented using one code system into information represented in a section. MAP describes abstract collections such as "The SNOMED-CT to ICD-10 map", along with the creators, intended use, code systems involved, etc.
The MAP_VERSION profile represents the actual content of a MAP at a given point in time. It carries the from and to components as well as a representation of the rules and process for the conversion
The Map_Entry profile represents individual entries in a Map_Version
The Statement profile provides a bridge between the CTS2 model structure and the underlying RDF/XML/etc.
An enumeration of the possible functional profiles, some or all of which can be implemented by a conformant CTS2 service
Indicates what PSM(s) are supported by the given service implementation.
The combination of a FunctionalProfile and a link to the service description that describes the function/structure
PSM
A link to the service description for this particular function. The href must reference an instance of BaseService
PSM
A resource that is implemented by a service instance
A functional profile that the service instance supports for the corresponding structure
PSM
A namespace reference that may include additional documentation about the scope of the namespace.
Documentation about the scope and origin of the namespace.
BaseService contains the components that are common to any CTS2 service implementation. It includes information about the service itself, the namespaces and formats that are known to the service and the structural, functional and representation profiles that are supported by the service instance.
A short name that identifies the particular service and implementation.
A description of the service, its use, etc.
The version or release identifier of the service.
A reference to the individual or organization that provides the service.
A list of the representation formats supported by the service. Example: text/html, text/xml, application/json
The default format used by the service unless otherwise specified.
The set of service profiles that are supported by this service implementation
The particular implementation type(s) supported by this profile
The set of namespaces recognized by this service. Because many namespace identifiers tend to be cryptic (i.e. HL7 OIDs, BioPortal URL's, etc.), knownNamespace includes the namespace name, an optional URI \emph{and} a place to provide textual detail describing what the namespace references. Note that namespace names must be unique across an entire CTS2 implementation - the same namespace name cannot represent one namespace in code system A
and a second in code system B. Note also that namespace names are \emph{local} to a service instance. Information that is communicated between service instances, recorded in data tables or client software \emph{must} use full URIs.
The set of attributes that can be changed whenever an instance of a ResourceVersionDescription is updated.
The export destination
The number of elements that have been exported so far
The result of a change set validation call
An indicator that determines whether a change set was successfully added or not.
The CTS2 URI(s) of the resulting resources
A ordered sequence of log entries. The order of the entries is determined by the specific CTS2 service implementation and should not be assumed by client applications.
An entry in sequence of messages related to a process or task
An external identifier that uniquely names the message. ExternalURI is present to enable automated processing of log entries where appropriate. The significance and use of messageID is not addressed within the context of the CTS2 specification
The time the entry was made
The text of the message
The name of the program or application that created the entry
The LoggingLevel entries are modeled after the corresponding levels in the Apache log4j package. As with the log4j package, each level includes the entries in the lower level. In particular, levels are ordered. For the standard levels, we have DEBUG < INFO < WARN < ERROR < FATAL.
Detailed (verbose) information about the process or operation that allows a user to determine exactly what transpired
Informative messages about the progress of or results of a requested operation
Represents potential problems that do will not prevent completion of the requested operation, but may require attention or intervention.
Represents an error that, while serious, may under circumstances be ignored and processing may continue
Represents an error that prevents further processing. FATAL errors cannot be ignored or overridden.
The state of a running or completed load or export process.
The set of log records created by the process
A message summarizing the final results of the process
The date and time that the process finished execution if it isn't still running
The number of errors (LoggingLevel = ERROR or FATAL) encountered by the process so far
The number of warnings (LoggingLevel = WARN) encountered by the process so far
The date and time that the process began execution
BaseQueryService represents the set of attributes and operations that are common across all query service implementations. It includes generic directory manipulation functions as well as enumerations of the permissible values for query parameters in the given service context.
The set of properties that are used in one or more instances of the resource represented by this service. This list includes all properties that are can be used in queries in this service, independent of the entryState or temporal state of the resource(s) being searched.
The match algorithms that can be used in filters for this service instance.
The set of model attributes that can be referenced in filter instances for the given service implementation.
The common metadata about a CTS2 service instance that is shared among all service instances.
A change set URI along with the date and time it was applied to a particular service implementation
The date and time that a change set was applied to a given service instance
The URI of the change set that was applied
An ordered list of ChangeSetEntrys. The order of the list reflects the order in which the change sets were applied to the service instance
A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The
entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.
A combination of a namespace identifier and a local name that, together, uniquely references an entity known to the service
An ExternalURI that references a class, property or individual
Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same
resources.
a LocalIdentifier that references a unique resource within the context of the service implementation and type of resource being accessed
an ExternalURI that references a unique resource within the context of the resource type
A set of zero or more NameOrURI elements
A parameter used in queries where multiple elements are provided. It determines whether a candidate element must satisfy all restrictions or just one or more restriction in order to be considered as satisfying the restriction composite
the candidate passes only if all of the elements are present
the candidate passes if any of the supplied elements are present
Parameters that control the return format, number of elements and amount of time that can be taken for a query to complete.
The maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.
The maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.
The local identifier or URI of the return format for query results.
The local identifier or URI of the sort criteria for query results.
An indicator that determines whether the given service access request applies only to elements that are currently marked as ACTIVE in the context of the particular query or to both ACTIVE and INACTIVE entries.
The inquiry only applies to ACTIVE elements.
The inquiry applies to both ACTIVE and INACTIVE entries
The context that controls the behavior of a read or query.
Determines whether the query only applies to only active or all entries.
The spoken or written language that should be used for the results of the inquiry, where appropriate.
The URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile
The contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile.
An ordered list of sort criterion. The first entry in the list identifies the primary sort order, the second entry the sub sort order, etc.
The particular attribute, property or special element to be sorted along with the sort direction
The sort order to be applied to the element.
The type and name of the attribute, property or special element to be sorted
The collating order of a sort.
Sort in ascending collation order.
Sort in descending collation order.