Summary
Description of the profile
The Semantic Infrastructure keeps track of each version, any relevant provenance information (e.g., who made the change), and supports the concept of being able to revert to any prior state. This version control would include the authoring of any new metadata (making contexts more explicit) and the assertions of model alignments.
Version specializes capabilities architecturally implied by its associated concepts of Change . The implied architectural capabilities are described in the following paragraphs.
Change 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.
Capabilities
Requirements traceability
Requirement |
Source |
Capability |
|---|---|---|
View the history on a particular data element to view changes on prior versions that exist in caDSR. |
Gap Analysis::Manage::026.1 - Data Element History |
|
Provide a LexWiki tooling versioning management and upgrade mechanism. |
Gap Analysis::Manage::136 - LexWiki tooling versioning management |
|
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. |
Semantic Infrastructure Requirements::Artifact Management::Artifact Lifecycle Management |
|
In conjunction with CDISC-1 distributed Knowledge Repository a tool will be needed to create/add, delete, update/modify and retire content from multiple sources. There must be version control for CDISC objects (e.g., attributes, associations, classes, etc.). This includes versioning information about CDISC controlled terminology and any external authoritative source terminologies. The KR and Tools should provide a mechanism for preserving and viewing the contributing sources and/or contributing organizations for each object. Detailed tracking of contributions among objects is not required. Source: * CDISC Share Pilot Report * CDISC Requirements Package 1 - NCI Semantic Infrastructure, 5/28/2010, Section 2.5 & Section 2.8 |
Gap Analysis::CDISC::CDISC-16 - Ensure versioning, change management and traceability |
|
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. |
Semantic Profile::OASIS SOA::Service Description Model |
versioning from inherited abstract profile ChangeconfigurationManagement from inherited abstract profile Changetransition from inherited abstract profile Change |
configurationManagement
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
dataElementHistory
Description
View the history on a particular data element to view changes on prior versions that exist in caDSR.
Requirements addressed
- Artifact Lifecycle Management
- CDISC-16 - Ensure versioning, change management and traceability
- 026.1 - Data Element History
Overview of possible operations
lexWikiToolingVersioningManagement
Description
Provide a LexWiki tooling versioning management and upgrade mechanism.
Requirements addressed
Overview of possible operations
transition
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 conversions.
Requirements addressed
Overview of possible operations
versioning
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 scheme.
