This wiki has undergone a migration to Confluence found Here


From HL7Wiki
Jump to navigation Jump to search

Back to Templates Registry Pilot

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

Binding Syntax

The Template Registry will need to capture all elements of value set binding to fully represent the template and its required value set(s). However not all of the binding syntax components will be useful in the template searching functionality.

It is expected that Binding Type and Stability components 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

A Value Set can be bound in two ways:

Model Binding

Context Binding

Value Set Assertion

There are 3 types of assertion that can be made to a Value Set:

Maximum Value Set

Minimum Value Set

Ignore Value Set

Value Set Stability

Dynamic Value Set

Static Value Set

Meta Data Elements

Below are current known meta data elements for vocabulary and other data elements that should be included in a template fit for registration. They are drawn from the Templates DSTU and the Templates Registry Data Model documents.

Terminology Templates

Code System and Value Set meta data are drawn from the Templates Registry Business Requirement & Templates DSTU 2007 with the exception of Concept Domain - this vocabulary data element 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 code system 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.

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