Summary
Description of the profile
The ability to publish and discover information models will be supported by the semantic infrastructure, and the platform will leverage these capabilities.
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.
Discovery is the set of capabilities which enable searching for artifacts that best meet the search criteria specified by the service participant.
Aspects of discovery include:
- Search for services, policies, and other artifact descriptions accessible via some repository mechanism
- Search for operational characteristics of artifacts, which are metrics defined in artifact descriptions. The information is accessible via infrastructure monitoring capabilties or directly from services.
- Tracking and notification mechanisms related to artifact usage, service availability, operational conformance
Capabilities associated with discovery are delineated in the functional profiles inherited, and specialized, by the discovery profile, namely:
- Artifact
- Metrics
- Interoperability
A well-defined service Information Model.
The capabilities of the Information Model include:
- describes the syntax and semantics of the messages used to denote actions and events;
- describes the syntax and semantics of the data payload(s) contained within messages;
- documents exception conditions in the event of faults due to network outages, improper message/data formats, etc.;
- is both human readable and machine processable
- is referenceable from the Service Description artifact.
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 make use of defined semantics, where the semantics may be used for categorization or providing other property and value information for description classes.
Architectural implications of semantics on the Semantic Infrastructure are reflected in the following capabilities:
- semantic models that provide normative descriptions of the utilized terms, where the models may range from a simple dictionary of terms to an ontology showing complex relationships and capable of supporting enhanced reasoning. This is a refinement of the Artifact metadata capability.
- mechanisms to support the storage, referencing, and access to these semantic models. This is a refinement of the Artifact store capability.
- configuration management mechanisms to capture the normative description of each semantic model and to apply a unique identifier in a manner consistent with an identified versioning scheme. This is a refinement of the Change configurationManagement capability.
- one or more mechanisms to support the storage, referencing, and access to conversion relationships between semantic models, and the mechanisms to carry out such conversions.
Capabilities
- batchLoadCurationArtifacts
- clinicalDataElements
- complianceDiscovery
- configurationManagement
- diagramModelBinding
- discovery
- exception
- identity
- interoperabilityDiscovery
- lineOfBusinessArtifacts
- localizeDataElements
- message
- metadata
- metrics
- metricsDiscovery
- monitor
- payload
- provenance
- semanticConversion
- serviceBinding
- serviceChangeNotification
- store
- transition
- versioning
Requirements traceability
Requirement |
Source |
Capability |
|---|---|---|
Allow model owners to create sandboxed data elements and concepts as necessary to use in their models |
Gap Analysis::Manage::006 - Sandboxed Data Elements and Concepts |
|
Provide mechanism for users to load their model directly into the KR – instead of the curators and model owners doing the data load |
Gap Analysis::Import::040 - Load Models Directly to KR |
|
Provide the capability to bulk/batch load new content from a variety of sources for later curation. |
Gap Analysis::Import::050 - Bulk,batch load |
|
Provide an easy way to create data elements from line of business artifacts such as a spreadsheet or database description |
Gap Analysis::Import::098.3 - Line of Business Artifacts |
|
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 |
|
CIC wants to be able to register and maintain the clinical data elements in a publicly available repository, |
Gap Analysis::HL7 CIC::CIC-1 - Store clinical data elements in a publicly available repository |
|
This set of requirements includes providing an application developer with the ability to define application-specific attributes (for example, defined using ISO 21090 healthcare datatypes) and an information model that defines the relationships between these attributes and other attributes in the broader ecosystem. In particular, the last requirement suggests linked datasets, where application developers can connect data in disparate repositories as if the repositories are part of a larger federated data ecosystem. Additional requirements include the ability to publish and discover information models. Support is needed for forms data and common clinical document standards, such as HL7 CDA. To support the use of binary data throughout the system, the binary data must be typed and semantically annotated. All Information models, their representation and binding to data-types and terminologies will be managed by the semantic infrastructure. The ability to publish and discover information models will be supported by the semantic infrastructure, and the platform will leverage these capabilities. Link to use case satisfied from caGRID 2.0 Roadmap: The pathology, radiology and other data have various data formats which must be described, and the information model for the patient record must link between these various datatypes. The complete information model includes semantic links between datasets to build a comprehensive electronic medical record. Annotations on data are defined and included in the information model. |
Semantic Infrastructure Requirements::caGRID 2.0 Platform and Terminology Integration::Data Representation and Information Models |
batchLoadCurationArtifacts, lineOfBusinessArtifacts, localizeDataElements, |
|
Semantic Profile::OASIS SOA::Governance Model |
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::Interacting with Services Model |
message from inherited abstract profile Information Model, payload from inherited abstract profile Information Model, exception from inherited abstract profile Information Model, serviceBinding from inherited abstract profile Information Model, diagramModelBinding from inherited abstract profile Information Model, |
|
Semantic Profile::OASIS SOA::Service Description Model |
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, semanticConversion from inherited abstract profile Semantic Model, monitor from inherited abstract profile Metrics, metrics from inherited abstract profile Metrics, metricsDiscovery from inherited abstract profile Metrics, complianceDiscovery from inherited abstract profile Metrics, interoperabilityDiscovery from inherited abstract profile Interoperability, serviceChangeNotification from inherited abstract profile Interoperability, |
batchLoadCurationArtifacts
Description
Provide the capability to bulk/batch load new content from a variety of sources for later curation.
Requirements addressed
Overview of possible operations
clinicalDataElements
Description
Store clinical data elements in a publicly available repository.
Requirements addressed
Overview of possible operations
complianceDiscovery
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
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
diagramModelBinding
Description
Is both human readable and machine processable.
Requirements addressed
Overview of possible operations
discovery
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
exception
Description
Documents exception conditions in the event of faults due to network outages, improper message/data formats, etc.
Requirements addressed
Overview of possible operations
identity
Description
Descriptions which include a unique identifier for the artifact.
Requirements addressed
Overview of possible operations
interoperabilityDiscovery
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
lineOfBusinessArtifacts
Description
Provide an easy way to create data elements from line of business artifacts such as a spreadsheet or database description
Requirements addressed
Overview of possible operations
localizeDataElements
Description
Allow model owners to create sandboxed data elements and concepts as necessary to use in their models
Provide mechanism for users to load their model directly into the KR – instead of the curators and model owners doing the data load
Requirements addressed
- 006 - Sandboxed Data Elements and Concepts
- 040 - Load Models Directly to KR
- Artifact Lifecycle Management
- Data Representation and Information Models
Overview of possible operations
message
Description
Describes the syntax and semantics of the messages used to denote actions and events
Requirements addressed
Overview of possible operations
metadata
Description
A representation of the meaning of terms used to describe the artifact, its functions, and its effects.
Requirements addressed
Overview of possible operations
metrics
Description
Access to metrics information generated or accessible by related services
Requirements addressed
Overview of possible operations
metricsDiscovery
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
monitor
Description
Access to platform infrastructure monitoring and reporting capabilities.
Requirements addressed
Overview of possible operations
payload
Description
Describes the syntax and semantics of the data payload(s) contained within messages
Requirements addressed
Overview of possible operations
provenance
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
semanticConversion
Description
One or more mechanisms to support the storage, referencing, and access to conversion relationships between semantic models, and the mechanisms to carry out such conversions.
Requirements addressed
Overview of possible operations
serviceBinding
Description
Is referenceable from the Service Description artifact.
Requirements addressed
Overview of possible operations
serviceChangeNotification
Description
Tools to appropriately track users of the descriptions and notify them when a new version of the description is available.
Requirements addressed
Overview of possible operations
store
Description
Accessible storage of artifacts and artifact descriptions, so service participants can access, examine, and use the artifacts as defined.
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.
