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

Difference between revisions of "Value Set Definition Standard Project"

From HL7Wiki
Jump to navigation Jump to search
 
(86 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
'''''A New Normative Standard for Value Set Definitions'''''
 
'''''A New Normative Standard for Value Set Definitions'''''
 +
 +
=Official Publication of '''Characteristics of a Formal Value Set Definition''' occurred June 16, 2016 =
 +
The official publication page [http://www.hl7.org/implement/standards/product_brief.cfm?product_id=437 HERE]<br>
 +
STU Comment Tracker [http://www.hl7.org/dstucomments/showdetail.cfm?dstuid=189 HERE]
 +
'''Please read, implement, and comment!'''
  
 
=Overview=
 
=Overview=
'''''[[DSTU ballot has officially PASSED but we have many comments to resolve. Please attend the weekly meeting to help]]'''''
+
'''''FINAL REVIEW OF STANDARD in preparation of PUBLICATION to occur at 2016 May WGM MONDAY Q1'''''
  
 
[From the PSS] Describe the elements that make up a “Value Set Definition”, and ballot this as a normative HL7 specification, including a demonstration of how this is met in FHIR profiles and HL7 Model Interchange Format (MIF).
 
[From the PSS] Describe the elements that make up a “Value Set Definition”, and ballot this as a normative HL7 specification, including a demonstration of how this is met in FHIR profiles and HL7 Model Interchange Format (MIF).
Line 19: Line 24:
  
 
==Conference Call Schedule and Minutes==
 
==Conference Call Schedule and Minutes==
 +
''Remember USA is now on STANDARD TIME EST is UTC -5''<br>
 +
'' Standard meetings are - Tuesdays @ 4pm EST for 90 min.''
 +
 +
'''Telephone uses standard HL7 Vocab number: 1 (770) 657-9270,,,598745#'''
 +
 +
=== Meeting will be one of the following web share environments ===
 +
 +
''Mikogo session''
 +
https://go.mikogo.com/?sp=&sid=073003565
 +
 +
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: 073-003-565
 +
# Enter your name
 +
# Click "Join Session"
  
''We are re-starting our weekly meetings at the same time as before - Tuesdays @ 3:30 ET for 90 min. '''New Mikogo ID'''''
+
''Join.Me session''
 +
https://join.me/tedsnewsessions
  
'''Telephone uses standard HL7 Vocab number: 1 (770) 657-9270,,,598745#'''
+
===Current Weekly Agenda===
  
Topic: VSD Regular weekly Meeting
+
# Agenda:
Date & Time: Tuesday at 13:00 UTC-07
+
## Discuss use of VSD in Templates
Duration: 1 hour 30 min
+
## Review of final "needs discussion" item(s) in ballot
 +
## Think of examples
 +
## Work on glossary
  
Please click on the link below to join my Mikogo session
 
https://go.mikogo.com/?sp=&sid=073003565
 
  
If the above link does not work, you can follow these steps instead to join a session:
+
Note - fixed CodeBasedContentSet on 2015-08-21 based on RM and TK skype call. Also added expressions as allowed "code".
# Go to http://go.mikogo.com
+
Need to consider where to place something that would allow expressions as valid members of a value set. Some sort of flag. This is also something that belongs on the binding syntax. Both places likely needed. As a VSD element it would control if the TS should consider an expression as valid - IE< this is a receiver function, and not so much a definition element that requires all potential expressions to be enumerated as "standing members" for any expansion.
# Enter the Session ID: 073-003-565
 
# Enter your name
 
# Click "Join Session"
 
  
Click on the following link to download a quick reference guide for participants:
+
=Updated Current Documents=
http://www.mikogo.com/jump/quickguide?uilang=en
+
Updated as of 2016-05-10
 +
# Current VSD Publication Spec doc [https://db.tt/vOaCr1zU HERE]
 +
# Current Ballot Comment doc [https://db.tt/MFXPLS5j HERE]
 +
==Value Set Definition Examples==
 +
Examples based on the HL7 Expression Syntax described in the VSD standard are available for download [http://wiki.hl7.org/index.php?title=HL7_VSD_Expression_Syntax HERE].
  
''Remember US ET remains on DST until November 2 so 3:30pm EDT is -4 UTC''
+
==Running list of Completed Issues==
 +
# Will submit as DSTU in Normative track and not as Normative in first ballot. [2014-07-22]
 +
# We completed the review of the Logical Elements/Functions to define Content Logical Definition based on the MIF
 +
## See [https://www.dropbox.com/s/30xaaeca1c0q32e/Valueset%20MIF%20ContentDefinition.docx Valueset MIF ContentDefinition] for updated comments.
 +
# Discussion on how to control use of DYNAMIC defined value sets continued on 12/20 meeting.
 +
## Rob and Lloyd still have to create document and use cases to explain approach to "STATUS" / DYNAMIC stability.
 +
# Metadata sheet review now complete
 +
## Completed discussion of Value Set Expansion metadata with changes added to end of spreadsheet.
 +
### A Value Set Definition can reference 0..* "Trusted Value Set Expansion Reference" that can be a service or an actual expansion
 +
### An Expansion can be characterized by a date (required), a time (optional) and an identifier (optional)
 +
# As of [https://db.tt/HtLncYja VSDSpec v18], UML model accurately describes those elements that are "definitional" in that if they change, a new value set or value set version should be created.
 +
# 4/22/14 Completed documentation of determination of VSD version STATUSes
 +
# This initial ballot will leave inclusion of concept expressions as value set members as OUT OF SCOPE. This remains highly important but will be addressed in the following ballot.
 +
# This document has the abstracted decisions from minutes. [https://www.dropbox.com/s/z5xwb8lswbvt3fi/Primary%20VSD%20decisions%20in%20Minutes.docx]
 +
# We will allow the use of slightly more complex datatypes (DSET and EN are currently used) [Example content attribute was discussed when this decision was reached]
 +
# ''Purpose'' changed to ''Scope'' in v24
 +
# We allow NonComputableContent CE to be included in a general CLD, therefore some CLD may have both computable and non-computable content.
 +
# Clarified that Value Set Reference CE should not also allow Code System Constraint Parameters as such a thing could be inconsistent with the actual referenced value set.
 +
# Clarified that the CLD “slot” in the value set version actually should hold, in essence, a “UnionwithContent” operation on the included content expressions. This can either be an implicit description of how to manage the CEs listed, or we can explicitly have a CLD point to 1..1 UnionWithContent
 +
# NCC will remain as part of the MIF-based syntax as a type of Code System Content with LOTS of best practice guidance by Lloyd and Ted. This DOES MEAN that MIF-based syntax CLD '''is not always computable''' 2015-06-09
 +
----
 +
# Items for discussion at upcoming Work Group Meeting
 +
## Acceptable modeling approach to add additional syntax types for CLD (see meeting notes Sept 23rd).
 +
## discussion of Jay Lyle's alternative model approach - he is to identify elements that he has left out and/or added before the WG meeting. Discussion Tuesday Q4.
  
===Upcoming Agenda Sept 30===
 
# Agenda items:
 
## Ted and Julie will not be on. Ted gone for next 4 sessions, Rob gone next week (7th).
 
### If we can find common time on Oct 6 we will move Oct 7 meeting to a different time on the 6th, otherwise it will be cancelled.
 
## We will focus on Review of wording change items, to block vote changes and punt on others.
 
## Static snapshot of Consolidated ballot is posted [https://db.tt/6sOuFdvf HERE]
 
## Rob (and Ted) have not had a chance to completely clean and categorize this yet.
 
# Last meeting (23rd) devoted to discussion on adding additional CLD syntax. (SCT/IHTSDO syntax (not yet published), OWL, MIF, other?)
 
## Discussion not completed. Setting up a time to meet with Woody.
 
## Will postpone discussion on this until core can attend. Perhaps Oct 6.
 
# Items completed
 
## Simplified 'Use'
 
# Plan to use two criteria for walking through comments:
 
## Commenters in attendance - review their comment. If attending, please send Rob and Ted notice.
 
## Review by section, then by general type
 
___
 
# Running list of Pre-Ballot Completed Issues:
 
## Will submit as DSTU in Normative track and not as Normative in first ballot. [2014-07-22]
 
## We completed the review of the Logical Elements/Functions to define Content Logical Definition based on the MIF
 
### See [https://www.dropbox.com/s/30xaaeca1c0q32e/Valueset%20MIF%20ContentDefinition.docx Valueset MIF ContentDefinition] for updated comments.
 
## Discussion on how to control use of DYNAMIC defined value sets continued on 12/20 meeting.
 
### Rob and Lloyd still have to create document and use cases to explain approach to "STATUS" / DYNAMIC stability.
 
## Metadata sheet review now complete
 
### Completed discussion of Value Set Expansion metadata with changes added to end of spreadsheet.
 
#### A Value Set Definition can reference 0..* "Trusted Value Set Expansion Reference" that can be a service or an actual expansion
 
#### An Expansion can be characterized by a date (required), a time (optional) and an identifier (optional)
 
## As of [https://db.tt/HtLncYja VSDSpec v18], UML model accurately describes those elements that are "definitional" in that if they change, a new value set or value set version should be created.
 
## 4/22/14 Completed documentation of determination of VSD version STATUSes
 
## This initial ballot will leave inclusion of concept expressions as value set members as OUT OF SCOPE. This remains highly important but will be addressed in the following ballot.
 
## This document has the abstracted decisions from minutes. [https://www.dropbox.com/s/z5xwb8lswbvt3fi/Primary%20VSD%20decisions%20in%20Minutes.docx]
 
## We will allow the use of slightly more complex datatypes (DSET and EN are currently used) [Example content attribute was discussed when this decision was reached]
 
## ''Purpose'' changed to ''Scope'' in v24
 
## We allow NonComputableContent CE to be included in a general CLD, therefore some CLD may have both computable and non-computable content.
 
## Clarified that Value Set Reference CE should not also allow Code System Constraint Parameters as such a thing could be inconsistent with the actual referenced value set.
 
## Clarified that the CLD “slot” in the value set version actually should hold, in essence, a “UnionwithContent” operation on the included content expressions. This can either be an implicit description of how to manage the CEs listed, or we can explicitly have a CLD point to 1..1 UnionWithContent
 
  
 
'''Final version of the Ballot''' - [https://db.tt/ePgxeIyB here].  
 
'''Final version of the Ballot''' - [https://db.tt/ePgxeIyB here].  
  
 
----
 
----
'''Minutes documents:'''
+
 
[https://www.dropbox.com/s/i806q7uw7wrusvj/20131016_VSD_Minutes.docx 20131016_VSD_Minutes]
+
==Minutes documents:==
[https://www.dropbox.com/s/ihcov0nbcn3c5el/20131022_VSD_Minutes.docx 20131022_VSD_Minutes]
+
All Minutes are on the [http://wiki.hl7.org/index.php?title=Vocab_VSD_Minutes VSD Minutes Page]
[https://www.dropbox.com/s/e6bk44ct0maibgz/20131030_VSD_Minutes.docx 20131030_VSD_Minutes]
 
[https://www.dropbox.com/s/z0fxat96m4zxi3w/20131106_VSD_Minutes.docx 20131106_VSD_Minutes]
 
[https://www.dropbox.com/s/m1g4hkniu67953e/20131113_VSD_Minutes.docx 20131113_VSD_Minutes]
 
[https://www.dropbox.com/s/m1g4hkniu67953e/20131113_VSD_Minutes.docx 20131120_VSD_Minutes]
 
[https://www.dropbox.com/s/m1g4hkniu67953e/20131113_VSD_Minutes.docx 20131122_VSD_Minutes]
 
[https://www.dropbox.com/s/ckeg7e9u5yqxy9u/20131127_VSD_Minutes.docx 20131127_VSD_Minutes]
 
[https://www.dropbox.com/s/oo6mg3jel5ca6j5/20131129_VSD_Minutes.docx 20131129_VSD_Minutes]
 
[https://www.dropbox.com/s/cntjwlrqd3fznsg/20131204_VSD_Minutes.docx 20131204_VSD_Minutes]
 
[https://www.dropbox.com/s/3ytc0r3tuipls3a/20131206_VSD_Minutes.docx 20131206_VSD_Minutes]
 
[https://www.dropbox.com/s/y6o8x497q2a26u3/20131211_VSD_Minutes.docx 20131211_VSD_Minutes]
 
[https://www.dropbox.com/s/yfzaiqsr2oru8y9/20131213_VSD_Minutes.docx 20131213_VSD_Minutes]
 
[https://www.dropbox.com/s/ojz102c6j97ixh8/20131218_VSD_Minutes.docx 20131218_VSD_Minutes]
 
[https://www.dropbox.com/s/cvo40nv085iebzq/20131220_VSD_Minutes.docx 20131220_VSD_Minutes]
 
[https://www.dropbox.com/s/9wqvtjymfs68hdy/20140103_VSD_Minutes.docx 20140103_VSD_Minutes]
 
[https://www.dropbox.com/s/0h7uxc6429sripi/20140108_VSD_Minutes.docx 20140108_VSD_Minutes]
 
[https://www.dropbox.com/s/0h7uxc6429sripi/20140115_VSD_Minutes.docx 20140115_VSD_Minutes]
 
[https://www.dropbox.com/s/0qre7d13fsv1p15/20140128_VSD_Minutes.docx 20140128_VSD_Minutes]
 
[https://www.dropbox.com/s/1xu1tt0m7x187us/20140204_VSD_Minutes.docx 20140204_VSD_Minutes]
 
[https://www.dropbox.com/s/kq1tprw6h42zrih/20140211_VSD_Minutes.docx 20140211_VSD_Minutes]
 
[https://www.dropbox.com/s/x8d07bozgt8im8b/20140218_VSD_Minutes.docx 20140218_VSD_Minutes]
 
[https://www.dropbox.com/s/shocefyj30shb9p/20140225_VSD_Minutes.docx 20140225_VSD_Minutes]
 
[https://www.dropbox.com/s/zww33icyiw4967n/20140304_VSD_Minutes.docx 20140304_VSD_Minutes]
 
[https://www.dropbox.com/s/1c9cujob79wstfs/20140311_VSD_Minutes.docx 20140311_VSD_Minutes]
 
[https://db.tt/vboUwCr5 20140318_VSD_Minutes]
 
[https://db.tt/xophnXUG 20140325_VSD_Minutes]
 
[https://db.tt/B1tzivUS 20140401_VSD_Minutes]
 
[https://db.tt/YDbh0qhp 20140408_VSD_Minutes]
 
[https://db.tt/xO73O6NT 20140415_VSD_Minutes]
 
[https://db.tt/fO7eEMeX 20140422_VSD_Minutes]
 
[https://www.dropbox.com/s/72qjhdmuckmd4sf/201404029_VSD_Minutes.docx 20140429_VSD_Minutes]
 
[https://db.tt/O75drace 20140513_VSD_Minutes]
 
[https://db.tt/1WhsSMk8 20140520_VSD_Minutes]
 
[https://db.tt/jDJoFC3h 20140527_VSD_Minutes]
 
[https://db.tt/PDOYpIQP 20140603_VSD_Minutes]
 
[https://db.tt/TX2r5F6D 20140610_VSD_Minutes]
 
[https://db.tt/9JC2QDYD 20140617_VSD_Minutes]
 
[https://db.tt/isvt6RO6 20140701_VSD_Minutes]
 
[https://www.dropbox.com/s/eadt4k3ugyht3dk/20140702_VSD_Minutes.docx 20140702_VSD_Minutes]
 
[https://www.dropbox.com/s/p1z5di0s7v99j97/20140708_VSD_Minutes.docx 20140708_VSD_Minutes]
 
[https://db.tt/3U5ZMk9x 20140722_VSD_Minutes]
 
[https://db.tt/nppi9563 20140729_VSD_Minutes]
 
[https://db.tt/otHfyhKF 20140910_VSD_Minutes]
 
[https://db.tt/EUFl8qry 20140923_VSD_Minutes]
 
  
 
==Key Target Dates==
 
==Key Target Dates==
  Now targeting September 2014 ballot submission
+
  Review of final publication draft at 2016 May WGM.
June. 29, 2014 - '''intention to ballot''' final day.
+
  Publication right after 2016 May WGM.
  July 13, 2014 - initial content deadline
+
  No need for re-ballot given DSTU status unless we want to do so.
  August 3, 2014 - Final deadline for content.
 
  
 
=Project Documents=
 
=Project Documents=
 
The project working documents are being maintained using Google Docs.    These can be found at:
 
The project working documents are being maintained using Google Docs.    These can be found at:
 
[[Links to project documents]]
 
[[Links to project documents]]

Latest revision as of 22:30, 16 June 2016

A New Normative Standard for Value Set Definitions

Official Publication of Characteristics of a Formal Value Set Definition occurred June 16, 2016

The official publication page HERE
STU Comment Tracker HERE

Please read, implement, and comment!

Overview

FINAL REVIEW OF STANDARD in preparation of PUBLICATION to occur at 2016 May WGM MONDAY Q1

[From the PSS] Describe the elements that make up a “Value Set Definition”, and ballot this as a normative HL7 specification, including a demonstration of how this is met in FHIR profiles and HL7 Model Interchange Format (MIF).

The definition of value sets is a required activity in completing the specification of most health information technology artefacts. To date, the approach for doing so has not been consistent within HL7 constructs and elsewhere. Many of the required elements and approaches are embedded in existing HL7 artefacts but not consistently. Currently, an explicit list of all the fields in an HL7 value set definition are surfaced only in the informative balloted MIF, with a general description of them in the normative Core Principles specification. A more accessible and standardized list of these fields is required to facilitate interoperability and sharing of value set definitions across HL7 artefacts and the Health IT community at large.

Success criteria: Publishing of the normative standard, and a demonstration of value set definitions that conform to this published normative specification.

Project Processes

This project is using DropBox as a collaborative document sharing process during the formative draft development process. If you are interested in viewing the current draft please attend the meetings. If you are interested in participating in the editing and review of the drafts, please send a request to get access to the dropbox folder to Rob McClure ( rmcclure AT mdpartners.com ).

Project Participants

Preparation Tooling

Conference Call Schedule and Minutes

Remember USA is now on STANDARD TIME EST is UTC -5
Standard meetings are - Tuesdays @ 4pm EST for 90 min.

Telephone uses standard HL7 Vocab number: 1 (770) 657-9270,,,598745#

Meeting will be one of the following web share environments

Mikogo session

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

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: 073-003-565
# Enter your name
# Click "Join Session"

Join.Me session

https://join.me/tedsnewsessions

Current Weekly Agenda

  1. Agenda:
    1. Discuss use of VSD in Templates
    2. Review of final "needs discussion" item(s) in ballot
    3. Think of examples
    4. Work on glossary


Note - fixed CodeBasedContentSet on 2015-08-21 based on RM and TK skype call. Also added expressions as allowed "code". Need to consider where to place something that would allow expressions as valid members of a value set. Some sort of flag. This is also something that belongs on the binding syntax. Both places likely needed. As a VSD element it would control if the TS should consider an expression as valid - IE< this is a receiver function, and not so much a definition element that requires all potential expressions to be enumerated as "standing members" for any expansion.

Updated Current Documents

Updated as of 2016-05-10

  1. Current VSD Publication Spec doc HERE
  2. Current Ballot Comment doc HERE

Value Set Definition Examples

Examples based on the HL7 Expression Syntax described in the VSD standard are available for download HERE.

Running list of Completed Issues

  1. Will submit as DSTU in Normative track and not as Normative in first ballot. [2014-07-22]
  2. We completed the review of the Logical Elements/Functions to define Content Logical Definition based on the MIF
    1. See Valueset MIF ContentDefinition for updated comments.
  3. Discussion on how to control use of DYNAMIC defined value sets continued on 12/20 meeting.
    1. Rob and Lloyd still have to create document and use cases to explain approach to "STATUS" / DYNAMIC stability.
  4. Metadata sheet review now complete
    1. Completed discussion of Value Set Expansion metadata with changes added to end of spreadsheet.
      1. A Value Set Definition can reference 0..* "Trusted Value Set Expansion Reference" that can be a service or an actual expansion
      2. An Expansion can be characterized by a date (required), a time (optional) and an identifier (optional)
  5. As of VSDSpec v18, UML model accurately describes those elements that are "definitional" in that if they change, a new value set or value set version should be created.
  6. 4/22/14 Completed documentation of determination of VSD version STATUSes
  7. This initial ballot will leave inclusion of concept expressions as value set members as OUT OF SCOPE. This remains highly important but will be addressed in the following ballot.
  8. This document has the abstracted decisions from minutes. [1]
  9. We will allow the use of slightly more complex datatypes (DSET and EN are currently used) [Example content attribute was discussed when this decision was reached]
  10. Purpose changed to Scope in v24
  11. We allow NonComputableContent CE to be included in a general CLD, therefore some CLD may have both computable and non-computable content.
  12. Clarified that Value Set Reference CE should not also allow Code System Constraint Parameters as such a thing could be inconsistent with the actual referenced value set.
  13. Clarified that the CLD “slot” in the value set version actually should hold, in essence, a “UnionwithContent” operation on the included content expressions. This can either be an implicit description of how to manage the CEs listed, or we can explicitly have a CLD point to 1..1 UnionWithContent
  14. NCC will remain as part of the MIF-based syntax as a type of Code System Content with LOTS of best practice guidance by Lloyd and Ted. This DOES MEAN that MIF-based syntax CLD is not always computable 2015-06-09

  1. Items for discussion at upcoming Work Group Meeting
    1. Acceptable modeling approach to add additional syntax types for CLD (see meeting notes Sept 23rd).
    2. discussion of Jay Lyle's alternative model approach - he is to identify elements that he has left out and/or added before the WG meeting. Discussion Tuesday Q4.


Final version of the Ballot - here.


Minutes documents:

All Minutes are on the VSD Minutes Page

Key Target Dates

Review of final publication draft at 2016 May WGM.
Publication right after 2016 May WGM.
No need for re-ballot given DSTU status unless we want to do so.

Project Documents

The project working documents are being maintained using Google Docs. These can be found at: Links to project documents