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.

Very rough document - typos and all....

Attempting to remove a lot of the authorship and custodianship metadata that is not directly supporting structural and semantic definition.

Services Oriented Architecture: HL7 Templates Profile Functional Specification

Introduction

This document describes the functional requirements of HL7 templates to support service specification references to and definitions of semantic content within a HL7 operating profile.

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
3. Terminology Binding - Terminology concept terms may be bound to constraint statements. This may provide semantic information throughout the constraint statement.
4. Explicit Constraints
   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

1. 1. Collection Type - Defines the type of collection that may be instansiated sorted list, unsorted list, set
   2. 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.
   3. Referenced - Reference to identified template to include specified constraints defined elsewhere.
   4. Choice - Statement of choice of a number of possible distinct explicitly defined constraints or referenced templates.
   5. Instantiation Criteria - Statement of criteria of allowed or exclusion properties of referenced templates not identified directly.
2. 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. Value Set - Includes assumed (default) values, fixed values and enumerations for string and coded value types.
   4. Code System - This constrains the code system to an allowed value set. This applies to the coded value types.
   5. Regular Expression - Defines allowed string patterns and applied to string types.
   6. 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.
   7. Identifier Root - This constrains the root of an identifier to an allowed value set. This applies to identifier types.