SOA: Minimal Functional Requirements

Attempting to enumerate minimal set of template functional items to be addressed for use as "Semantic Signifiers" withing the SOA (Services Oriented Architecture) SIG "Resource Locator and Update Service" specficiation.

Removed a lot of the authorship and custodianship metadata that is not directly supporting structural and semantic definition. Would like to bring in more requirements only as deemed necessary.

SOA: Semantic Signifiers - HL7 Profile Functional Specification

Introduction

This document describes the functional requirements of HL7 templates to support service oriented architecture specification usage. This enables definitions of constraints to content within a HL7 operating profile for a service.

Identification/Discovery

This section describes functional requirement items that support identification of the template instance explicitly or by discovery of for desired semantics

1. Identifier - An identifier must be bound to constraint statements. This allows reference to the template from other templates.
2. Name - This may be defined to provide an indication of semantics.
3. Semantics Description - This is a description of the semantics that may be inferred when this template is invoked. It will aid in determining whether the semantics are suitable for use in a desired context.
4. Version - This is an indication of the current revision of the template. Versions of a template require that there are no semantic differences??
5. Classification - Terminology concept terms may be bound to constraint statements. This may provide semantic information throughout the constraint statement.

Constraint

This section describes functional requirement items that support constraining a reference model structure, binding to concepts, specialization of templates.

1. Identifier - An identifier must be bound to constraint statements. This allows reference to any identified part of the constraint hierarchy.
2. Reference Model Identifier - Defines the reference model that is being constrained for this template.
3. Terminology Binding - Terminology concept terms may be bound to constraint statements. This may provide semantic information throughout the constraint statement.
4. Explicit Constraints - Constraint statements can be made on attributes and associations of a reference model.
   1. Multiplicity - The allowed range of instances allowed of specified attribute/association, this may be 0-not allowed, 1-allowed, greater than 1-a collection.
   2. Collection Type - Defines the type of collection that may be instansiated sorted list, unsorted list, set.
   3. Instantiation Conditions - Conditional statement defining the inclusion conditions of explicitly defined constraints or referenced templates. This may include reference to environmental variables and to instance values that are within the context of a given template.
   4. Referenced - Reference to identified template to include specified constraints defined in another template.
   5. Choice - Statement of choice of a number of possible distinct explicitly defined constraints or referenced templates.
   6. Instantiation Criteria - Statement of criteria of allowed or exclusion properties of referenced templates not identified directly.
5. Data Value Constraints - Data value constraints are specific constraints that support common ways of constraining specific data value types. In the HL7 profile this includes all HL7 datatypes.
   1. Range - Numeric range specification, supporting inclusive and exclusive ranges also single and double sided ranges. This includes numeric types and physical quantities.
   2. Measurement Units - This constrains measurement units to a value set that is allowed. This applies to physical quantities.
   3. Code System - This constrains the code system to an allowed set of code system identifiers. This applies to the coded value types.
   4. Value Set - Includes assumed (default) values, fixed values and enumerations for string and coded value types.
   5. Regular Expression - Defines allowed string patterns and applied to string types.
   6. Identifier Root - This constrains the root of an identifier to an allowed set of identifier root values. This applies to identifier types.
   7. Assertions - Stated assertions defining allowed instantiation constraints of values. This may depend on environment variables or other instantiated values within the context of the given template.

Analysis of MIF Support

MIF is the "Model Interchange Format" it is a HL7 artifact formalism for describing all modelling performed in HL7 v3.

It is implemented as a set of XML schemas.

mifStaticModelSerialized.xsd - specfically supports serializable models.

Identification/Discovery

Identifier

/serializedStaticModels/serializedStaticModel/@name

Name

/serializedStaticModels/serializedStaticModel/@name

Constraint

1. Identifier
2. Reference Model Identifier - Fixed to 'RIM' (?)
3. Terminology Binding - This applies only to clinical CMET or Template definitions. The entry point will be an act class within the clinical statement. The terminology binding is done via the Act.code value set. This can be expressed as a value set constraint on this attrbute. (?)
4. Explicit Constraints
   1. Multiplicity
   2. Collection Type
   3. Instantiation Conditions
   4. Referenced
   5. Choice
   6. Instantiation Criteria
5. Data Value Constraints
   1. Range
   2. Measurement Units
   3. Code System
   4. Value Set
   5. Regular Expression
   6. Identifier Root
   7. Assertions