NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Scrollbar
iconsfalse

Page info
title
title

Panel
titleContents of this Page
Table of Contents
minlevel5
Summary

...

Description of the profile

...

A service description defines or references the information needed to use, deploy, manage and otherwise control a service. This includes not only the information and behavior models associated with a service to define the service interface but also includes information needed to decide whether the service is appropriate for the current needs of the service consumer. Thus, the service description will also include information such as service reachability, service functionality, and the policies and contracts associated with a service.
An artifact is a managed resource within the Semantic Infrastructure.

An artifact is associated with the following capabilities:

  • descriptions to enable the artifact to be visible, where the description includes a unique identifier for the artifact and a sufficient, and preferably a machine processible, representation of the meaning of terms used to describe the artifact, its functions, and its effects;
  • one or more discovery mechanisms that enable searching for artifacts that best meet the search criteria specified by the service participant; where the discovery mechanism will have access to the individual artifact descriptions, possibly through some repository mechanism;
  • accessible storage of artifacts and artifact descriptions, so service participants can access, examine, and use the artifacts as defined.
    Artifact descriptions change over time and their contents will reflect changing needs and context.

Architectural implications of change on the Semantic Infrastructure are reflected in the following capabilities:

  • mechanisms to support the storage, referencing, and access to normative definitions of one or more versioning schemes that may be applied to identify different aggregations of descriptive information, where the different schemes may be versions of a versioning scheme itself;
  • configuration management mechanisms to capture the contents of the each aggregation and apply a unique identifier in a manner consistent with an identified versioning scheme;
  • one or more mechanisms to support the storage, referencing, and access to conversion relationships between versioning schemes, and the mechanisms to carry out such conversions.
    Artifact Descriptions may capture very focused information subsets or can be an aggregate of numerous component descriptions. Service description is an example of a likely aggregate for which manual maintenance of all aspects would not be feasible.

Architectural implications of composition on the Semantic Infrastructure are reflected in the following capabilities:

  • tools to facilitate identifying description elements that are to be aggregated to assemble the composite description;
  • tools to facilitate identifying the sources of information to associate with the description elements;
  • tools to collect the identified description elements and their associated sources into a standard, referenceable format that can support general access and understanding;
  • tools to automatically update the composite description as the component sources change, and to consistently apply versioning schemes to identify the new description contents and the type and significance of change that occurred.
    Descriptions of interactions are important for enabling auditability and repeatability, thereby establishing a context for results and support for understanding observed change in performance or results. Infrastructure services provide mechanisms to support service interaction.

Architectural implications of interactions on the Semantic Infrastructure are reflected in the following capabilities:

  • one or more mechanisms to capture, describe, store, discover, and retrieve interaction logs, execution contexts, and the combined interaction descriptions;
  • one or more mechanisms for attaching to any results the means to identify and retrieve the interaction description under which the results were generated.
  • mediation services such as message and event brokers, providers, and/or buses that provide message translation/transformation, gateway capability, message persistence, reliable message delivery, and/or intelligent routing semantics;
  • binding services that support translation and transformation of multiple application-level protocols to standard network transport protocols;
  • auditing and logging services that provide a data store and mechanism to record information related to service interaction activity such as message traffic patterns, security violations, and service contract and policy violations
  • security services that abstract techniques such as public key cryptography, secure networks, virus protection, etc., which provide protection against common security threats in a SOA ecosystem;
  • monitoring services such as hardware and software mechanisms that both monitor the performance of systems that host services and network traffic during service interaction, and are capable of generating regular monitoring reports.
    Descriptions provide up-to-date information on what a resource is, the conditions for interacting with the resource, and the results of such interactions. As such, the description is the source of vital information in establishing willingness to interact with a resource, reachability to make interaction possible, and compliance with relevant conditions of use.

Architectural implications of interoperability on the Semantic Infrastructure are reflected in the following capabilities:

  • one or more discovery mechanisms that enable searching for described resources that best meet the criteria specified by a service participant, where the discovery mechanism will have access to individual descriptions, possibly through some repository mechanism;
  • tools to appropriately track users of the descriptions and notify them when a new version of the description is available.
    Artifact Descriptions include references to metrics which describe the operational characteristics of the subjects being described

Architectural implications of metrics on the Semantic Infrastructure are reflected in the following capabilities:

  • access to platform infrastructure monitoring and reporting capabilities
  • access to metrics information generated or accessible by related services
  • mechanisms to catalog and enable discovery of which metrics are available for a described artifact and information on how these metrics can be accessed;
  • mechanisms to catalog and enable discovery of compliance records associated with policies, contracts, and constraints that are based on these metrics.
    Artifact Descriptions include references to policies defining conditions of use and optionally contracts representing agreement on policies and other conditions.

Architectural implications of policy on the Semantic Infrastructure are reflected in the following capabilities:

  • descriptions to enable the policy modules to be visible, where the description includes a unique identifier for the policy and a sufficient, and preferably a machine processible, representation of the meaning of terms used to describe the policy, its functions, and its effects;
  • one or more discovery mechanisms that enable searching for policies that best meet the search criteria specified by the service participant; where the discovery mechanism will have access to the individual policy descriptions, possibly through some repository mechanism;
  • accessible storage of policies and policy descriptions, so service participants can access, examine, and use the policies as defined.

Policy capabilities are specialization of Artifact capabilities.

Capabilities

Requirements traceability

An important class of joint service action is the business transaction, or contract exchange. Many interactions between participants in the SOA ecosystem are based around business transactions. A business transaction is a joint action engaged in by two or more participants in which the ownership of one of more resources is exchanged.

A classic business transaction is buying some good or service, but there is a huge variety of kinds of possible business transactions. Key to the concept of business transaction is the contract or agreement to exchange. The form of the contract can vary from a simple handshake to an elaborately drawn contract with lawyers giving advice from all sides.

A completed transaction establishes a set of social facts relating to the exchange; typically to the changes of ownerships of the resources being exchanged.

Business Agreement

A business agreement is an agreement entered into by two or more partners that constrains their future behaviors and permitted states.

A business agreement is typically associated with business transactions: the transaction is guided by the agreement and an agreement can be the result of a transaction.

Business transactions often have a well defined life-cycle: a negotiation phase in which the terms of the transaction are discussed, an agreement action which establishes the commitment to the transaction, an action phase in which the agreed-upon items are exchanged (they may need to be manufactured before they can be exchanged), and a termination phase in which there may be long-term commitments by both parties but no particular actions required (e.g., if the exchanged goods are found to be defective, then there is likely a commitment to repair or replace them).

From an architectural perspective, the business transaction often represents the top-most mode of interpretation of service interactions. When participants interact in a service, they exchange information and perform actions that have an effect in the world. These exchanges can be interpreted as realizing part of, and in support of, business transactions.

Business Process

A business process is a description of the tasks, participants' roles and information needed to fulfill a business objective.

Business processes are often used to describe the actions and interactions that form business transactions. This is most clear when the business process defines an activity involving parties external to the organization; however, even within an enterprise, a business process typically involves multiple participants and stakeholders.

In the context of transactions mediated and supported by electronic means, business processes are often required to be defined well enough to permit automation. The forms of such definitions are often referred to as choreographies:

Process Choreography

A process choreography is a description of the possible interactions that may take place between two or more participants to fulfill an objective.

A choreography is, in effect, a description of what the forms of permitted joint actions are when trying to achieve a particular result. Joint actions are by nature formed out of the individual actions of the participants; a choreography can be used to describe those interlocking actions that make up the joint action itself.

Data updates may include updates to multiple data sources, necessitating the need for transactions.

Data updates that trigger transactions are captured by the platform and are propagated upstream to the semantic infrastructure. An example would be the platform monitoring events to identify changes to data.

Transaction Management specializes capabilities architecturally implied by its associated concepts of Composition , Service Composition . The implied architectural capabilities are described in the following paragraphs.

Composition Artifact Descriptions may capture very focused information subsets or can be an aggregate of numerous component descriptions. Service description is an example of a likely aggregate for which manual maintenance of all aspects would not be feasible.

Architectural implications of composition on the Semantic Infrastructure are reflected in the following capabilities:

  • tools to facilitate identifying description elements that are to be aggregated to assemble the composite description;
  • tools to facilitate identifying the sources of information to associate with the description elements;
  • tools to collect the identified description elements and their associated sources into a standard, referenceable format that can support general access and understanding;
  • tools to automatically update the composite description as the component sources change, and to consistently apply versioning schemes to identify the new description contents and the type and significance of change that occurred.

Service Composition Service composition mechanisms to support orchestration of service-oriented business processes and choreography of service-oriented business collaborations.

The capabilities of Service Composition include:

  • Declarative and programmatic compositional languages
  • Orchestration and/or choreography engines that support multi-step processes as part of a short-lived or long-lived business transaction;
  • Orchestration and/or choreography engines that support compensating transactions in the presences of exception and fault conditions.

...

Capabilities

...

Requirements traceability
Gap Analysis::Interface::002 - Web-based browsing and registrationSemantic Infrastructure Requirements::Artifact Management::Artifact Lifecycle ManagementSemantic Profile::OASIS SOA::Governance ModelSemantic Profile::OASIS SOA::

Requirement

Source

Capability

Data management includes linking of disparate data sets and updates of data across the ecosystem. Data updates may include updates to multiple data sources, necessitating the need for transactions. Linkages between the different disparate data sets will be managed by the semantic infrastructure. Data updates that trigger transactions are captured by the platform and are propagated upstream to the semantic infrastructure. An example would be the platform monitoring events to identify changes to data. Link to use case satisfied from caGRID 2.0 Roadmap: the patient has an electronic medical record that spans multiple institutions. The clinical workup data (for example, genomics and proteomics data) is linked to the clinical care record; similarly pathology and radiology findings must be attached to the patient's electronic medical record.

Semantic Infrastructure Requirements::caGRID 2.0 Platform and Terminology Integration::

Anchor
_16_5_1_24a0131_1283090068349_28533_4506
_16_5_1_24a0131_1283090068349_28533_4506
Data Management

dataUpdateMonitor

Interaction is the activity involved in using a service to access capability in order to achieve a particular desired real world effect, where real world effect is the actual result of using a service. An interaction can be characterized by a sequence of actions. Consequently, interacting with a service, i.e. performing actions against the service--usually mediated by a series of message exchanges--involves actions performed by the service. Different modes of interaction are possible such as modifying the shared state of a resource. Note that a participant (or agent acting on behalf of the participant) can be the sender of a message, the receiver of a message, or both. Interacting with Services has the following architectural implications on mechanisms that facilitate service interaction: A well-defined service Information Model, as elaborated in the inherited Information Model profile. A well-defined service Behavior Model, as elaborated in the inherited Behavior Model profile. Service composition mechanisms to support orchestration of service-oriented business processes and choreography of service-oriented business collaborations, as elaborated in the inherited Service Composition profile. Infrastructure services that provides mechanisms to support service interaction, as elaborated in the inherited Interaction profile. A layered and tiered service component architecture that supports multiple message exchange patterns (MEPs)l, as elaborated in the inherited Message Exchange profile.

Semantic Profile::OASIS SOA

Requirement

Source

Capability

Provide an integrated, web-based environment for model/service registration and browsing.

Anchor
_16_5_1_24a0131_1283084940599_74729_4293_16_5_1_24a0131_1283084940599_74729_4293

webBasedRegistration,

The use of well defined service metadata promotes better discovery and reuse of services during design and run time. Service metadata includes information about service interactions and dependencies. It also includes a classification scheme for organizing services based on business objectives, domain, and usage. It also links services to all the supporting artifacts in the specification and provides a placeholder for conformance statements. This enables better reuse across the enterprise and eliminates redundancy.

Semantic Infrastructure Requirements::Service Discovery and Governance::

Anchor
_16_5_1_24a0131_12830901020201283763631267_915508880282_45514612
_16_5_1_24a0131_12830901020201283763631267_915508880282_45514612
Administer Interacting with Services

serviceDescriptionModel, webBasedRegistration,

Artifact lifecycle management and metadata requirements include the ability to: * Manage lifecycle, governance and versioning of the models, content and forms * Establish relationships and dependencies between models, content and forms * Determine provenance, jurisdiction, authority and intellectual property * Create represention and views of the information, realized through the appropriate transforms * Provide access control and other security constraints * Create annotations for better discovery and searching of artifacts * Develop usage scenarios and context for the information * Provide terminology and value set binding The artifacts are bound to the services via the service metadata. The service metadata combined with the artifacts and supporting metadata provide a comprehensive service specification. The artifact management requirements listed above are derived from the following use cases: * caEHR: The caEHR project has adopted ECCF for specifications and CDA documents for interoperability. The caEHR project requirements include the need for an infrastructure for managing all the artifacts generated during specification process, including HL7 models and documents. The caEHR project also intends to publish these artifacts for the community and vendors. The infrastructure needs to support better discovery, making all the relevant information available in the right context. * ONC and other external EHR adopters: ONC has adopted CCD and CCR for meaningful use. All national EHR implementations are expected to support forms and the semantics of these forms play a critical role in interoperability. The semantic infrastructure must provide a mechanism to create, store and manage these forms. * Clinical Trials: Clinical trials use forms to capture clinical information, and the semantics captured by these forms are critical for interoperability and reporting. The semantic infrastructure must provide a mechanism to manage the lifecycle of these forms.

Anchor
_16_5_1_24a0131_1283090023842_213150_4485_16_5_1_24a0131_1283090023842_213150_4485

webBasedRegistration,

 

Anchor
_16_5_1_24a0131_1283763638521_214441_4616_16_5_1_24a0131_1283763638521_214441_4616

Model

compositionalLanguage from inherited abstract profile Service CompositionbusinessTransaction from inherited abstract profile Service CompositioncompensatingTransaction from inherited abstract profile Service Composition

A service description is an artifact, usually document-based, that defines or references the information needed to use, deploy, manage and otherwise control a service. This includes not only the information and behavior models associated with a service to define the service interface but also includes information needed to decide whether the service is appropriate for the current needs of the service consumer. Thus, the service description will also include information such as service reachability, service functionality, and the policies and contracts associated with a service. A service description artifact may be a single document or it may be an interlinked set of documents. Architectural implications of service description on the Semantic Infrastructure are reflected in the following functional decomposition: * Description will change over time and its contents will reflect changing needs and context. This is elaborated in the inherited Change profile. * Description makes use of defined semantics, where the semantics may be used for categorization or providing other property and value information for description classes. This is elaborated in the inherited Semantic Model profile. * Descriptions include reference to policies defining conditions of use and optionally contracts representing agreement on policies and other conditions. This is elaborated in the inherited Policy profile. * Descriptions include references to metrics which describe the operational characteristics of the subjects being described. This is elaborated in the inherited Metrics profile. * Descriptions of the interactions are important for enabling auditability and repeatability, thereby establishing a context for results and support for understanding observed change in performance or results. This is elaborated in the inherited Interaction profile. * Descriptions may capture very focused information subsets or can be an aggregate of numerous component descriptions. Service description is an example of a likely aggregate for which manual maintenance of all aspects would not be feasible. This is elaborated in the inherited Composition profile. * Descriptions provide up-to-date information on what a resource is, the conditions for interacting with the resource, and the results of such interactions. As such, the description is the source of vital information in establishing willingness to interact with a resource, reachability to make interaction possible, and compliance with relevant conditions of use. This is elaborated in the inherited Interoperability profile. Policy capabilities are specialization of Artifact capabilities.

monitor from inherited abstract profile Metrics, metrics from inherited abstract profile Metrics, discovery from inherited abstract profile Artifact, identity from inherited abstract profile Artifact, metadata from inherited abstract profile Artifact, store from inherited abstract profile Artifact,

 

Semantic Profile::OASIS SOA::

Anchor
_16_5_1_24a0131_12837636312671283763560612_880282868976_46124608
_16_5_1_24a0131_12837636312671283763560612_880282868976_4612
Interacting with Services
4608
Service Description Model

interactionLog compositionArchivefrom inherited abstract profile Interaction, interactionResults Compositionassembly from inherited abstract profile Interaction, mediation CompositioncompositionChange from inherited abstract profile Interaction, binding CompositioncomponentAcquisition from inherited abstract profile Interaction, logging from inherited abstract profile Interaction, security from inherited abstract profile Interaction, monitoring from inherited abstract profile Interaction,

 

Composition

Anchor
_16_5_1_24a0131_

...

1283703443772_

...

860088_

...

3293
_16_5_1_24a0131_

...

1283703443772_

...

860088_

...

3293
assembly

...

Description

...

versioning from inherited abstract profile Change, configurationManagement from inherited abstract profile Change, transition from inherited abstract profile Change, discovery from inherited abstract profile Artifact, identity from inherited abstract profile Artifact, metadata from inherited abstract profile Artifact, store from inherited abstract profile Artifact, monitor from inherited abstract profile Metrics, metrics from inherited abstract profile Metrics, metricsDiscovery from inherited abstract profile Metrics, complianceDiscovery from inherited abstract profile Metrics, interactionLog from inherited abstract profile Interaction, interactionResults from inherited abstract profile Interaction, compositionArchive from inherited abstract profile Composition, assembly from inherited abstract profile Composition, compositionChange from inherited abstract profile Composition, componentAcquisition from inherited abstract profile Composition, interoperabilityDiscovery from inherited abstract profile Interoperability, serviceChangeNotification from inherited abstract profile Interoperability,

...

Description

Tools to facilitate identifying description elements that are to be aggregated to assemble the composite description.

Requirements addressed
Overview of possible operations

...

Tools to facilitate identifying description elements that are to be aggregated to assemble the composite description.

...

Requirements addressed

...

...

Description

binding services that support translation and transformation of multiple application-level protocols to standard network transport protocols;

Requirements addressed
Overview of possible operations

...

Description

Mechanisms to catalog and enable discovery of compliance records associated with policies, contracts, and constraints that are based on these metrics.

Requirements addressed
Overview of possible operations

...

Description

Tools to facilitate identifying the sources of information to associate with the description elements.

Requirements addressed
Overview of possible operations

...

Description

Tools to collect the identified description elements and their associated sources into a standard, referenceable format that can support general access and understanding.

Requirements addressed
Overview of possible operations

...

Description

Tools to automatically update the composite description as the component sources change, and to consistently apply versioning schemes to identify the new description contents and the type and significance of change that occurred.

Requirements addressed
Overview of possible operations

...

Description

Mechanisms to support the storage, referencing, and access to normative definitions of one or more versioning schemes that may be applied to identify different aggregations of descriptive information, where the different schemes may be versions of a versioning scheme itself.

Requirements addressed
Overview of possible operations

...

Description

One or more discovery mechanisms that enable searching for artifacts that best meet the search criteria specified by the service participant; where the discovery mechanism will have access to the individual artifact descriptions, possibly through some repository mechanism.

Requirements addressed
Overview of possible operations

...

Description

Descriptions which include a unique identifier for the artifact.

Requirements addressed
Overview of possible operations

...

Description

One or more mechanisms to capture, describe, store, discover, and retrieve interaction logs, execution contexts, and the combined interaction descriptions.

Requirements addressed
Overview of possible operations

...

Description

One or more mechanisms for attaching to any results the means to identify and retrieve the interaction description under which the results were generated.

Requirements addressed
Overview of possible operations

...

Description

One or more discovery mechanisms that enable searching for described resources that best meet the criteria specified by a service participant, where the discovery mechanism will have access to individual descriptions, possibly through some repository mechanism.

Requirements addressed
Overview of possible operations

...

Description

auditing and logging services that provide a data store and mechanism to record information related to service interaction activity such as message traffic patterns, security violations, and service contract and policy violations

Requirements addressed
Overview of possible operations

...

Description

mediation services such as message and event brokers, providers, and/or buses that provide message translation/transformation, gateway capability, message persistence, reliable message delivery, and/or intelligent routing semantics;

Requirements addressed
Overview of possible operations

...

Description

A representation of the meaning of terms used to describe the artifact, its functions, and its effects.

Requirements addressed
Overview of possible operations

...

Description

Access to metrics information generated or accessible by related services

Requirements addressed
Overview of possible operations

...

Description

Mechanisms to catalog and enable discovery of which metrics are available for a described artifact and information on how these metrics can be accessed.

Requirements addressed
Overview of possible operations

...

Description

Access to platform infrastructure monitoring and reporting capabilities.

Requirements addressed
Overview of possible operations

...

Description

monitoring services such as hardware and software mechanisms that both monitor the performance of systems that host services and network traffic during service interaction, and are capable of generating regular monitoring reports.

Requirements addressed
Overview of possible operations

...

Description

While the Resource identity provides the means to know which subject and subject description are being considered, Provenance as related to the Description class provides information that reflects on the quality or usability of the subject. Provenance specifically identifies the entity (human, defined role, organization, ...) that assumes responsibility for the resource being described and tracks historic information that establishes a context for understanding what the resource provides and how it has changed over time. Responsibilities may be directly assumed by the Stakeholder who owns a Resource or the Owner may designate Responsible Parties for the various aspects of maintaining the resource and provisioning it for use by others. There may be more than one entity identified under Responsible Parties; for example, one entity may be responsible for code maintenance while another is responsible for provisioning of the executable code. The historical aspects may also have multiple entries, such as when and how data was collected and when and how it was subsequently processed, and as with other elements of description, may provide links to other assets maintained by the Resource owner.

Requirements addressed
Overview of possible operations
Anchor
_16_5_1_24a0131_

...

1283773157435_

...

437893_

...

5349
_16_5_1_24a0131_

...

1283773157435_

...

437893_

...

5349

...

businessTransaction

...

Description

...

security services that abstract techniques such as public key cryptography, secure networks, virus protection, etc., which provide protection against common security threats in a SOA ecosystemOrchestration and/or choreography engines that support multi-step processes as part of a short-lived or long-lived business transaction;

...

Requirements addressed

...

...

Overview of possible operations

...

Anchor
_16_5_1_24a0131_

...

1283773157994_

...

271631_

...

5360
_16_5_1_24a0131_

...

1283773157994_

...

271631_

...

5360

...

compensatingTransaction

...

Description

...

Tools to appropriately track users of the descriptions and notify them when a new version of the description is availableOrchestration and/or choreography engines that support compensating transactions in the presences of exception and fault conditions.

...

Requirements addressed

...

...

Overview of possible operations

...

Anchor
_16_5_1_24a0131_

...

1283704509983_

...

673729_

...

3325
_16_5_1_24a0131_

...

1283704509983_

...

673729_

...

3325

...

componentAcquisition

...

Description

...

Service Model with capabilities to create, destroy, edit, maintain service descriptionsTools to facilitate identifying the sources of information to associate with the description elements.

...

Requirements addressed

...

...

Overview of possible operations

...

Anchor
_16_5_1_24a0131_

...

1283773156758_

...

309844_

...

5338
_16_5_1_24a0131_

...

1283773156758_

...

309844_

...

5338

...

compositionalLanguage

...

Description

...

Accessible storage of artifacts and artifact descriptions, so service participants can access, examine, and use the artifacts as defined.Declarative and programmatic compositional languages

Requirements addressed

...

...

Overview of possible operations

...

Anchor
_16_5_1_24a0131_

...

1283703443770_

...

810122_

...

3292
_16_5_1_24a0131_

...

1283703443770_

...

810122_

...

3292

...

compositionArchive

...

Description

...

One or more mechanisms to support the storage, referencing, and access to conversion relationships between versioning schemes, and the mechanisms to carry out such conversionsTools to collect the identified description elements and their associated sources into a standard, referenceable format that can support general access and understanding.

...

Requirements addressed

...

...

Overview of possible operations

...

Anchor
_16_5_1_24a0131_

...

1283703443775_

...

178969_

...

3294
_16_5_1_24a0131_

...

1283703443775_

...

178969_

...

3294

...

compositionChange

...

Description

...

Configuration management mechanisms to capture the contents of the each aggregation and apply a unique identifier in a manner consistent with an identified versioning schemeTools to automatically update the composite description as the component sources change, and to consistently apply versioning schemes to identify the new description contents and the type and significance of change that occurred.

...

Requirements addressed

...

...

Overview of possible operations

...

Anchor

...

_16_5_1_24a0131_1283377451182_460305_8896
_16_5_1_24a0131_1283377451182_460305_8896
dataUpdateMonitor

...

Description

...

Data updates may include updates to multiple data sources, necessitating the need for transactions.

Data updates that trigger transactions are captured by the platform and are propagated upstream to the semantic infrastructure. An example would be the platform monitoring events to identify changes to data

...

Description

Provide an integrated, web-based environment for model/service registration and browsing.

...

Requirements addressed

...

...

Overview of possible operations

...

Scrollbar
iconsfalse