This wiki has undergone a migration to Confluence found Here
<meta name="googlebot" content="noindex">

Difference between revisions of "SOA: Minimal Functional Requirements"

From HL7Wiki
Jump to navigation Jump to search
(transform external doc into Wiki page)
Line 12: Line 12:
 
===Identification/Discovery===
 
===Identification/Discovery===
 
This section describes functional requirement items that support identification of the template instance explicitly or by discovery of for desired semantics
 
This section describes functional requirement items that support identification of the template instance explicitly or by discovery of for desired semantics
#Identifier
+
#Identifier - An identifier must be bound to constraint statements.  This allows reference to the template from other templates.
An identifier must be bound to constraint statements.  This allows reference to the template from other templates.
+
#Name - This may be defined to provide an indication of semantics.
#Name
+
#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.
This may be defined to provide an indication of semantics.
+
#Version - This is an indication of the current revision of the template.  Versions of a template require that there are no semantic differences??
#Semantics Description
+
#Classification - Terminology concept terms may be bound to constraint statements.  This may provide semantic information throughout the constraint statement.
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.
 
#Version
 
This is an indication of the current revision of the template.  Versions of a template require that there are no semantic differences??
 
#Classification
 
Terminology concept terms may be bound to constraint statements.  This may provide semantic information throughout the constraint statement.
 
  
 
===Constraint===
 
===Constraint===
 
This section describes functional requirement items that support constraining a reference model structure, binding to concepts, specialization of templates.
 
This section describes functional requirement items that support constraining a reference model structure, binding to concepts, specialization of templates.
#Identifier
+
#Identifier - An identifier must be bound to constraint statements.  This allows reference to any identified part of the constraint hierarchy.
An identifier must be bound to constraint statements.  This allows reference to any identified part of the constraint hierarchy.
 
 
#Reference Model Identifier
 
#Reference Model Identifier
 
+
#Terminology Binding - Terminology concept terms may be bound to constraint statements.  This may provide semantic information throughout the constraint statement.
#Terminology Binding
 
Terminology concept terms may be bound to constraint statements.  This may provide semantic information throughout the constraint statement.
 
 
#Explicit Constraints
 
#Explicit Constraints
##Cardinality
+
##Cardinality - The allowed range of instances allowed of specified data
The allowed range of instances allowed of specified data
+
##Collection Type - Defines the type of collection that may be instansiateds sorted list, unsorted list, set
 
+
##Instantiation Conditions - Conditional statement defining the inclusion conditions of explicitly defined or referenced templates.  This may include reference to environmental variables and to instance information that is within the context of a given template.
##Collection Type
+
##Choice - Statement of choice of a number of possible distinct explicitly defined or referenced templates.
Defines the type of collection that may be instansiateds sorted list, unsorted list, set
+
##Instantiation Criteria - Statement of criteria of allowed or exclusion properties of unspecified templates.
##Instantiation Conditions
+
##Assertions - Stated assertions defining allowed instantiation constraints.
Conditional statement defining the inclusion conditions of explicitly defined or referenced templates.  This may include reference to environmental variables and to instance information that is within the context of a given template.
+
##Referenced - Reference to identified template to include specified constraints defined elsewhere.
##Choice
+
#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.
Statement of choice of a number of possible distinct explicitly defined or referenced templates.
+
##Range - Numeric range specification, supporting inclusive and exclusive ranges also single and double sided ranges.  This includes numeric types and physical quantities.
##Instantiation Criteria
+
##Measurement Units - This constrains measurement units to a value set that is allowed.  This applies to physical quantities.
Statement of criteria of allowed or exclusion properties of unspecified templates.
+
##Value Set - Includes fixed values and enumerations for string and coded value types.
##Assertions
+
##Code System - This constrains the code system to a value set that is allowed.  This applies to the coded value types.
Stated assertions defining allowed instantiation constraints.
+
##Regular Expression - Defines allowed string patterns and applied to string types.
##Referenced
 
Reference to identified template to include specified constraints defined elsewhere.
 
 
 
 
 
#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.
 
##Range
 
Numeric range specification, supporting inclusive and exclusive ranges also single and double sided ranges.  This includes numeric types and physical quantities.
 
##Measurement Units
 
This constrains measurement units to a value set that is allowed.  This applies to physical quantities.
 
##Value Set
 
Includes fixed values and enumerations for string and coded value types.
 
##Code System
 
This constrains the code system to a value set that is allowed.  This applies to the coded value types.
 
##Regular Expression
 
Defines allowed string patterns and applied to string types.
 

Revision as of 05:19, 22 May 2006

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. Cardinality - The allowed range of instances allowed of specified data
    2. Collection Type - Defines the type of collection that may be instansiateds sorted list, unsorted list, set
    3. Instantiation Conditions - Conditional statement defining the inclusion conditions of explicitly defined or referenced templates. This may include reference to environmental variables and to instance information that is within the context of a given template.
    4. Choice - Statement of choice of a number of possible distinct explicitly defined or referenced templates.
    5. Instantiation Criteria - Statement of criteria of allowed or exclusion properties of unspecified templates.
    6. Assertions - Stated assertions defining allowed instantiation constraints.
    7. Referenced - Reference to identified template to include specified constraints defined elsewhere.
  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. Value Set - Includes fixed values and enumerations for string and coded value types.
    4. Code System - This constrains the code system to a value set that is allowed. This applies to the coded value types.
    5. Regular Expression - Defines allowed string patterns and applied to string types.