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

Binding Syntax

From HL7Wiki
Jump to navigation Jump to search

Binding Syntax

This project is a joint effort between CGIT and Vocabulary.

  1. Project now chaired by Rob McClure, building on work from Wendy, Ted, Frank O., Rob H. and Rob S.
  2. Current project document with minutes (latest work at the bottom) HERE

Scope

Define the human readable expression of the vocabulary constraints in implementation guides (Model Bindings) and by Realms as published sets of Context Bindings. Define the expression of the Value Set Assertion, a Model Binding, a Context Binding, and a Context Domain constraint. Information expressed in the syntax should be isomorphic to the normative definition of the data items comprising vocabulary constraints in Core Principles and the MIF ballots.

General meeting Agenda

Regular fortnightly meeting occurs Every Other Tuesday 2p ET for 60 minutes
Remember USA is now on STANDARD TIME EST is UTC -5

Meetings post-Orlando is every other week starting Jan. 19 - Tuesdays @ 2pm EST for 60 min.

Telephone uses standard HL7 Vocab number: 1 (770) 657-9270,,,598745# - NOT THE SHARED SCREEN NUMBER FOR MIKOGO OR OTHERS

Meeting will be one of the following web share environments

Mikogo session

https://go.mikogo.com/?sp=&sid=368206475

If the above link does not work, you can follow these steps instead to join a session:
# Go to http://go.mikogo.com
# Enter the Session ID: 368-206-475
# Enter your name
# Click "Join Session"

Join.Me session

https://join.me/tedsnewsessions

The above link works with any browser. Once there:

# Click on "Knock To Enter"

The March 29, 2016 meeting will use the join.me session above


Current Working Material

Binding must specify, and only need specify the following

  1. The information necessary to determine an Expansion Set. This means every binding MUST fully specify how to determine the value set version and code system version to be used – IE: Which expansion is to be used? The intention is that the specification of the value set expansion will follow the approach noted in the Value Set Definition project. This means that every binding will always be pointing to an actual value set and guidance indicating if all implementers are to use that value set or can do something different.
    1. The exact syntax to be used for the binding statement is to be described here (TBD) and will be fully aligned with the Value Set Definition project and Core Principles
    2. Binding needs to specify how to allow a change in the defined expansion. This may need to be blended into the items noted in section #3. The binding syntax will describe the value set expansion specification and also state if subsequent implementation guides can use a different value set or must only use the specified value set.
      1. Given that the specific value set must be identified via the parameters included which must characterize a specific expansion content:
        1. If "downstream" changes in the value set to be used are allowed, then such a specification must clarify if
          1. A different value set may be used (therefore control and responsibility is ceded to the downstream steward.) This is a SHOULD binding. This is similar to Preferred/example that provide an expansion that may be changed. In V3 this is similar to representative, in CDA it is similar to SHOULD, wherein the binding may be further fully constrained and then used in an implementable guide, but a completely different value set my be bound as an alternative as long as the value set meets the required scope.
          2. Only the value set identified (by the parameters noted) can be used therefore any change in the value set to be used MUST be managed by the original value set steward because they would be creating a new value set definition version. This is a MUST binding.
    3. Alternatively, binding of the coded data element can be deferred to a downstream specification. To do this the coded data element is associated with a semantic category, such as a HL7 V3 concept domain. This association is not a value set binding. This approach is intended to provide strict guidance on the scope of the value set that will eventually be bound. This association states that value set scope eventually bound MUST be consistent with the scope of the semantic category used to describe the association.
    4. Restriction to only values that are within the expansion - CLOSED
      1. This approach is expected to be the vast majority. This approach supports the notion described in #1 wherein a subsequent implementation guide can create a new value set that replaces the one noted in the current specification. The guidance provided can also state the behavior subsequent value set authors must follow when creating the value set to be implemented. For example, noting that any subsequent value set created MUST include all codes in the value set in the base specification.
      2. It is noted that there are circumstances where a CLOSED binding may not be further constrained, and thus can be thought of as "FIXED".
      3. Sender perspective
        1. Must only send values in the expansion
      4. Receiver perspective
        1. Must receive without error values in the expansion
        2. Error for any other value
    5. Binding allows use of values that are not in the expansion - OPEN
      1. Sender perspective:
        1. Must send from expansion if idea is in the expansion
        2. May send something not in expansion if idea is not in the expansion
          1. Must Flag the instance – “OTHR” (Flavour Of Null yet is really not a null)
            1. Send a code and an identification of code system (can be local)
            2. Send text and no code
            3. Send a “reason that expansion code can not be sent” – This is a true flavour of null
      2. Receiver Perspective
        1. Must be able to identify when received code is in the expansion and not report an error
        2. Identify when a data instance contains content not in the expansion but is sent appropriately
  2. Describe what further constraints may be applied in a downstream use of the specified binding and yet still be considered conformant with the original binding:
    1. What further constraints on the specified binding can be done, i.e.: what further changes can be made.
    2. Presently an Element Binding may optionally include that the stated binding is a MIN or a MAX binding. When used, both a MIN and MAX binding MUST both be defined. If MIN/MAX is not stated then the binding is to function as a MIN binding.
      1. MIN binding describe the concepts that an implementation MUST fully support
      2. MAX binding MUST include all the MIN concepts with all additional concepts noted as those that SHOULD be supported.
      3. Concepts not included in the MAX binding but from the same code system are EXCLUDED from use. This is consistent with the expectation that even with an OPEN value set as defined below, no concept that falls outside a MAX binding should be sent.
      4. Any constraint on the binding MUST result in a new MAX value set that is a proper subset of the upstreambinding MAX value set.
      5. Any constraint on the binding MUST result in a set of concepts that are within the semantic range of any defined concept domain.
    3. How to implement based on the specified binding without any further constraint, i.e.; How to generate the value set expansion based on the currently specified binding.
    4. Some of this should be defined as default behavior.
    5. V2 Binding strength is in this bucket
    6. Can we clarify that a code may be sent as if the binding was OPEN even when CLOSED (e.g. New lab code for new test when set of allowed known tests are in the existing deterministic expansion and want strict adherence to the existing expansion set.

Working Example to be rendered using the semantics described

Example
Data element used to report drug resistance in a culture.
The value set would be drugs to which the organism (known or unknown) is resistant. The degree of resistance is communicated via a different element. The value set initially could be used to describe any drug that could be assessed for resistance but then would be constrained for specific uses in subsequent guides. Need to address situation where a drug that was constrained out "upstream" is now needed again, and when a new drug appears to which resistance needs to be assessed.
From the Current Working Material section.
1.2.1.1: If "downstream" changes in the value set to be used are allowed, then such a specification must clarify 1) if a different value set can be used instead (SHOULD), 2) or you must use the same value set (MUST).
In which of those choices does Allowance for a subsequent use of this element binding where in the use is a subset of the original value set. Does this require a new value set?
We currently allow FHIR in the $Expand function to obtain only a subset of the expansion set and use that as the functional value set expansion set for the value set.

  1. The question we must address
    1. is if this is a conformant expansion of the value set as defined?
    2. if we do allow this, must we identify that the "sub-expansion" is being used? We did say that was required in FHIR. Not sure how they did this.

Minutes

Minutes now on separate page

Use Cases

This section is where we will list use cases that are to be described using the approach noted

  1. Emerging disease tracking registry
  2. Data transmission where successive implementation guides can add additional codes to those specified in the specification being constrained
    1. National value set -> state value set -> local value set
  3. Start from typical base standard value set with no needed change to implement
    1. Same as above but initial VS was an example and must be made implementable
  4. V2 Lab (LRI) examples with the use of national to state to implemented specifications all using binding identifiers.


Prior Binding Syntax Material Page