TerminologyStrategy

Back to Templates Registry Pilot

Vocabulary Binding Syntax- Please refer to the Core Principles and Properties of V3 Models. Please note this material is going under HL7 normative ballot and is only linked here as a reference guide for binding syntax.

Meta Data Searching

Searching Capability

Terminology Templates

Code System and Value Set meta data is drawn from the Templates Registry Business Requirement & Templates DSTU 2007 with the exception of Concept Domain - this vocabulary binding methodology was introduced by MnM & Vocab work groups subsequent to the Templates DSTU publication

Code System Template

Element	Type	Conformance	Info	Searchable (Y/N)
Code	String	M	An expression in a syntax defined by the code system which describes the concept. Usually this would be a simple code, but post-coordinated expressions may also be used.	Y
Code System	String	M	The identity of the codeSystem that defines the syntax and concepts used in the code. This must be a UID, as defined in the rules for the CD.codeSystem property in the V3 abstract datatypes.	Y
Code System Version	String	O	If applicable, a version descriptor defined specifically for the given code system. For further information, consult the rules for the CD.codeSystemVersion property in the V3 abstract datatypes.	Y
OID	String	M	A globally unique string representing an ISO identifier for a code system.	Y

Value Set Template

Element	Type	Conformance	Documentation	Searchable (Y/N)
Value Set Name	String	M	Name of the Value Set	Y
Binding Strength	Boolean (CNE or CWE)	M	This is to indicate whether the value set can allow for local codes (CWE) or only the exact list of concepts in the value set (CNE).	N
Concept domain	String	O	Refer to the Concept Domain Template for Concept Domain meta data	Y
Binding Realm	String	O	If the value set is bound to a concept domain, what is the binding realm e.g. Universal, Example, or Representative. CD.codeSystemVersion property in the V3 abstract datatypes.	Y
Binding Type	String	O	Indicates if this value set is used in model binding or context binding.	Y
OID	String	O	A globally unique string representing an ISO identifier for a value set.	Y
Description	String	O	Description of the value set	Y
Code System	String	O	Code system(s) the value set draw the concepts drawn from.	Y
Value Set Assertion	String	O	The filter defines the collection concepts that make up the value set.	N
Value Set Stability	String	O	Indicates if the value set is dynamically or statically managed.	Y

Concept Domain Template

Element	Conformance	Info	Searchable (Y/N)
Concept Domain Name	M	Name of the Concept domain	Y
Concept domain Definition	M	Definition of the concept domain	Y
Binding Realm	M	Indicates the binding syntax depending which type of binding syntax is done - please refer to the Core Principles and Properties of Version 3 Models, section on Binding Vocabulary To Coded Model Elements.	Y

Other Data Model Elements

Element	Conformance	Info	Searchable (Y/N)
Purpose	M	Purpose of the registered artifact in human readable terms.	N
Identifier	M	Identifier generated by the templates registry for the artifact registered.	Y
Source	M	Organization which created the artifact.	Y
Status	M	Current status of the artifact registered.	Y
Registered Date	M	The date the artifact was registered into the registry.	N
Effective Date	M	The date the artifact can be actively used and/or search.	N
Revision Date	M	The most recent date the artifact was revised.	N
Expiration Date	O	The as of date the artifact is no longer active.	N

Binding Syntax

The Template Registry will need to capture all elements of value set binding to fully represent the template and it's required value sets. But not all of the binding syntax component will be useful in template searches. It is expected that Binding type and Stability may be important for determining search reliability because searches based on value set contents that are context bound may change during implementation, and dynamic value set content may change with updates in terminology version.

Binding Types

Value Set can be bound in two ways:

Model Binding - directly binding a coded attribute or data type property to a specific Value Set Assertion or fixed code in the Vocabulary Declaration for the coded element.

Context Binding - association between a Concept Domain, a Binding Realm, and the Value Set Assertion published separately from static models and datatype specifications that reference those Concept Domains.

For the pilot of the template registry, at this time, it is an open issue to determine how to search specific terms in value sets which are context binding.

Value Set Assertion

Maximum, Minimum, Ignore Value Sets

Value Set Stability

Dynamic, Static value sets