A holistic view on Vocabulary Binding CGIT-Vocab Project Rob McClure Ted Klein, Rob Snelick, Frank Oemig Wendy Huang, Susan Barber, Richard Esmond, and others 1 December 2018 MD Partners, Inc.

Vocabulary Binding Semantics OLD project, reinvigorated 2 years ago Previously called Vocabulary Binding Syntax Committed to representing: All binding-related information Any HL7 product family approach Using common semantics but not requiring a single syntax This means we need to show how current implemented, useful requirements and guidance can be represented using the proposed approach – EXAMPLES are TBD 1 December 2018 MD Partners, Inc.

Binding Semantics project Everything is always on wiki.hl7.org “Current Working Material” Vocabulary Page/Projects/Binding Syntax http://wiki.hl7.org/index.php?title=Binding_Syntax - Current_Working_Material 1 December 2018 MD Partners, Inc.

Three general categories of rules specified Terminology Binding intends to specify a set of rules to control the use of coded concepts within a specification Three general categories of rules specified Information required to identify specific codes that are to be used for each of the coded data elements in the specification Information required to specify expected behaviors in the exchange of coded information by conformant applications Requirements for allowed constraints in derived specifications A complete value set binding statement for an implementation often depends on extra-IG info. 1 December 2018 MD Partners, Inc.

VS Expansion set determination requires 3 things SHALL include a value set identifier that will resolve to a full value set definition,  MAY include a value set version identifier or a date that will constrain to a single value set version. The default when not specified in the binding or a further constraint is the most currently available. MAY specify the version of each needed code system, or a date that will constrain to a single code system version. The default when not specified in the binding or a further constraint is the most currently available. 1 December 2018 MD Partners, Inc.

Implementable or Unimplementable Bindings A Value Set Binding describes an IMPLEMENTABLE terminology binding that has two flavors: Direct Value Set Binding is a declaration that binds a value set directly to a model element and when this is done, all jurisdictions must remain conformant to the binding which can still allow change based on additional binding information Indirect Value Set Binding is a declaration that binds a value set to a Concept Domain that exists to describe the intended model element scope. 1 December 2018 MD Partners, Inc.

Implementable or Unimplementable Bindings A Domain Binding is an UNIMPLEMENTABLE terminology binding that is a declaration that binds a Concept Domain to (usually) one or more model elements. As such a Domain Binding simply describes a scope that characterizes a value set binding (specified elsewhere or in future) for the associated model elements.  1 December 2018 MD Partners, Inc.

Binding Types 1 December 2018 MD Partners, Inc.

A Value Set Binding To A Data Element SHALL describe a Content Value Set Binding and, MAY describe a NULL Value Set Binding. The allowed content to be exchanged for the model element will be determined by the union of value set expansions specified by the Content Value Set Binding plus the NULL Value Set Binding. 1 December 2018 MD Partners, Inc.

A Value Set Binding must specify, and only need specify SHALL specify the information necessary to determine a specific Expansion Set SHALL specify one of the following Binding Strengths to describe Expected behaviors for Sending/originating data Receiving/consuming data NEA: Coding No Exceptions Allowed CEA: Coding with Exceptions Allowed - "Exception value" SHALL be identified as such SHALL specify Guidance on further constraints may be applied in a downstream use 1 December 2018 MD Partners, Inc.

Further Guidance section Binding guidance verbs provide guidance on how a subsequent IG can change the specified expansion and remain conformant. They do not define how the currently implemented specified value set is manipulated. If used, the value set defined is a different value set. FIXED CLOSED EXTEND In addition to the value set binding guidance verbs above, a MAX Content Value Set Guidance MAY be specified RESTRICT OPEN 1 December 2018 MD Partners, Inc.

Guidance Verb: FIXED The value set defined SHALL be fully implemented with "no more" additional concepts, and "no less" concepts than those included in the defined value set expansion. Note that a FIXED binding MAY specify only a value set identifier and so be quite dynamic in the specified expansion set to which the implementers are tied at a given time. A "downstream" conformant IG based on this binding SHALL be FIXED. 1 December 2018 MD Partners, Inc.

Guidance Verb: CLOSED A conformant implementation SHALL use 1..N concepts from the expansion as defined by the bound value set but MAY create a new value set that defines an expansion that is a formal subset. Again, any binding can allow dynamic expansions. A "downstream" conformant IG based on this binding MUST be CLOSED or FIXED. 1 December 2018 MD Partners, Inc.

Guidance Verb: EXTEND A conformant implementation must use all concepts from the expansion as defined by the bound value set but may add additional concepts for exchange This binding supports future bindings that are either FIXED or CLOSED + the current idea of Coded With Extensions (V3 CWE) A "downstream" conformant IG based on this binding MUST be either EXTEND, CLOSED or FIXED. The intention (for all guidance verbs) is that the new concepts introduced do not represent the same ideas as those already available as long as the implementer has access to the code system used. 1 December 2018 MD Partners, Inc.

Guidance Verb: RESTRICT A conformant implementation SHALL use 0..N concepts from the expansion as defined by the bound value set but may add additional concepts for exchange This binding is essentially a combination of CLOSED + EXTEND. This is computably similar to an OPEN binding but is intended to be interpreted as more restrictive. A "downstream" conformant IG based on this binding MUST be either RESTRICT, CLOSED or FIXED. 1 December 2018 MD Partners, Inc.

Guidance Verb: OPEN A conformant implementation may use 0..N concepts from the expansion as defined by the bound value set (i.e.; the implementation does not have to use all the concepts in the defined expansion) and may also add additional concepts for exchange. This binding is essentially a combination of CLOSED + the current idea of Coded With Extensions (V3 CWE) This is the most permissive Binding A "downstream" conformant IG based on this binding can be of any type. 1 December 2018 MD Partners, Inc.

Guidance: MAX value set A MAX Content Value Set Guidance describes a value set of concepts from which the Content Value Set MUST be a subset. Technically implementable (all the characteristics of a value set) But, IS NOT the Content Value Set Binding. The MAX Value Set Guidance is only conformance-testable guidance to a subsequent  Content Value Set Binding. Can be a binding to a code system 1 December 2018 MD Partners, Inc.

Example 1 December 2018 MD Partners, Inc.

Please consider early implementation! Please Participate! Please consider early implementation! Please read the wiki and comment: http://wiki.hl7.org/index.php?title=Binding_Syntax#Current_Working_Material 1 December 2018 MD Partners, Inc.