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
Line 109: Line 109:
 
## 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
 
## 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
  
  Latest (v28) version of doc [https://db.tt/ZX2Er5NK here].  
+
  Latest (v29) version of doc [https://db.tt/0ZIViB97 here].  
  
 
----
 
----

Revision as of 02:46, 27 June 2014

A New Normative Standard for Value Set Definitions

Overview

[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

New Meeting Time 

Weekly meeting to occur Tuesdays 3:30 -5pm ET

Remember US ET changes on March 9 in the US so 4pm EDT is -4 UTC
Phone: +1 770-657-9270, Participant Code: 598745

Webmeeting Info - Note - no password is needed anymore:

Topic: Value Set Definition (VSD) weekly call
Date & Time: Tuesday at 15:30 UTC-04
Duration: 1 hour 30 min
Please click on the link below to join my Mikogo session
https://go.mikogo.com/?sp=&sid=559867466
If the above link does not work, you can follow these steps instead to join a session:
1. Go to http://go.mikogo.com
2. Enter the Session ID: 559-867-466
3. Enter your name
4. Click "Join Session"

Upcoming Meeting Agenda (6/24/14)

  1. 15 min: Logistics and key prior discussions
    1. New Meeting Time!
      1. If time-specific discussions are needed the affected individual should contact Rob and Ted before the meeting with the agenda items of interest so planning can occur.
      2. Rob will be on holiday - Ted will lead.
      3. Ted to confirm he has submitted _intent to ballot_.
    2. Planning
      1. Initial Submission in 3 weeks
      2. The target list that must be done in the next couple of weeks is below.
        1. 5.2.3.4.2 Type
        2. 5.2.4.1 Creation Date
        3. 6.2.1 CSPostCoordinationControl
        4. 6.2.2.2 VersionDate
        5. 6.2.2.5 UsesCodeSystemPartition
        6. 6.2.3 UsesCodeSystemSupplement
        7. 6.2.6.3 MaximumMultiplicity
        8. 6.2.6.4 QualPostCoordinationControl
        9. 6.4.1.2 HeadCode
        10. 6.4.2.1 IncludeWithProperty
        11. 6.4.2.1.2 Value
        12. 6.4.2.2 ExcludeWithProperty
        13. 6.4.2.2.2 Value
        14. 6.4.3.3 MaximumMultiplicity
        15. 6.4.3.4 TargetConcepts
        16. 6.4.5.1 ValueSet
        17. Missing section 7 Value Set Expansion.
      3. Confirm section sign-ups are getting attention. Do we need another call?
      4. Initial content submission is July 13
  2. 70 min: Continue document work
    1. If any updates of document based on assignments has occurred, review that first.
    2. Any useful confirmation/review of CLD functions diagram based on last week's discussion.
      1. Status on any work to do the following:
        1. Textual alignment in main document with model diagram _and_ examples.
        2. Overall walk-through of diagram - is this where we put the example discussion? See document for assignments.
        3. Instance examples for the examples - WBeeler
        4. Diagram of how value sets in example change with progression through UML
      2. Minor updates to value set diagram (sec 5) based on discussions from last week?
        1. Diagrams in latest (v27) document.
      3. Still need to confirm changed document to align with new approach to Revision History & Creation Info.
    3. Once above completed, continue document review using the above list of TBD sections:
    4. Potentially Discuss how proscriptive the spec should be to control different implementation interpretations.
    5. Discuss overall datatypes: MaximumMultiplicity datatype
    6. Consider continuing to Expansion Set section, or other
    7. Some of the sections have been "signed up for"
      1. RMcClure and JJames will focus on sections 2 and initial section 5
      2. Still hope HGrain will work on section 3
      3. WHuang and JCase will work on section 4
      4. Expect TKlein and LMcKenzie to work on front pieces and content of section 6
      5. WHuang will work on section 7
      6. Editorial support: Ken Stevenson, Serafina Versaggi, Gaye Dolin
  3. We strongly hope that all participants will remain engaged in the project. This decision was not lightly taken and is a reflection on the amount of work and the importance of that work
  4. Running list of Completed Issues:
    1. 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.
    2. 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.
    3. 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)
    4. 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.
    5. 4/22/14 Completed documentation of determination of VSD version STATUSes
    6. 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.
    7. This document has the abstracted decisions from minutes. [1]
    8. 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]
    9. Purpose changed to Scope in v24
    10. We allow NonComputableContent CE to be included in a general CLD, therefore some CLD may have both computable and non-computable content.
    11. 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.
    12. 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
Latest (v29) version of doc here. 

Minutes documents:

20131016_VSD_Minutes
20131022_VSD_Minutes
20131030_VSD_Minutes
20131106_VSD_Minutes
20131113_VSD_Minutes
20131120_VSD_Minutes
20131122_VSD_Minutes
20131127_VSD_Minutes
20131129_VSD_Minutes
20131204_VSD_Minutes
20131206_VSD_Minutes
20131211_VSD_Minutes
20131213_VSD_Minutes
20131218_VSD_Minutes
20131220_VSD_Minutes
20140103_VSD_Minutes
20140108_VSD_Minutes
20140115_VSD_Minutes
20140128_VSD_Minutes
20140204_VSD_Minutes
20140211_VSD_Minutes
20140218_VSD_Minutes
20140225_VSD_Minutes
20140304_VSD_Minutes
20140311_VSD_Minutes
20140318_VSD_Minutes
20140325_VSD_Minutes
20140401_VSD_Minutes
20140408_VSD_Minutes
20140415_VSD_Minutes
20140422_VSD_Minutes
20140429_VSD_Minutes
20140513_VSD_Minutes
20140520_VSD_Minutes
20140527_VSD_Minutes
20140603_VSD_Minutes
20140610_VSD_Minutes
20140617_VSD_Minutes

Key Target Dates

Now targeting September 2014 ballot submission
June. 29, 2014 - intention to ballot final day.  
July 13, 2014 - initial content deadline
August 3, 2014 - Final deadline for content.

Project Documents

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