This wiki has undergone a migration to Confluence found Here

Difference between revisions of "ValueSet FHIR Resource Proposal"

From HL7Wiki
Jump to navigation Jump to search
(Created page with "{{subst::Template:FHIR Resource Proposal}}")
 
Line 1: Line 1:
 
 
<div class="messagebox cleanup metadata">
 
<div class="messagebox cleanup metadata">
 
<div style="float: left;">[[Image:OpenHotTopic.GIF|35px| ]]</div>
 
<div style="float: left;">[[Image:OpenHotTopic.GIF|35px| ]]</div>
Line 13: Line 12:
  
  
=putProposedResourceNameHere=
+
=ValueSet=
  
 
<!-- Resource names should meet the following characteristics:
 
<!-- Resource names should meet the following characteristics:
Line 40: Line 39:
  
 
==FHIR Resource Development Project Insight ID==
 
==FHIR Resource Development Project Insight ID==
 
+
Pending
 
<!-- Please specify the id of your work group’s PSS for doing FHIR work.  (If submitted but not yet approved, just write “pending”.) The link to the PSS template can be found here: http://gforge.hl7.org/gf/download/docmanfileversion/6832/9398/HL7FHIR_DSTUballotPSS-20120529.doc -->
 
<!-- Please specify the id of your work group’s PSS for doing FHIR work.  (If submitted but not yet approved, just write “pending”.) The link to the PSS template can be found here: http://gforge.hl7.org/gf/download/docmanfileversion/6832/9398/HL7FHIR_DSTUballotPSS-20120529.doc -->
  
 
==Scope of coverage==
 
==Scope of coverage==
 
 
<!-- Define the full scope of coverage for the resource.  The scope must be clearly delineated such that it does not overlap with any other existing or expected resource.  The scope will be used to govern "what is the set of potential applications to consider when evaluating what elements are 'core' – i.e. in the 80%"
 
<!-- Define the full scope of coverage for the resource.  The scope must be clearly delineated such that it does not overlap with any other existing or expected resource.  The scope will be used to govern "what is the set of potential applications to consider when evaluating what elements are 'core' – i.e. in the 80%"
  
Line 56: Line 54:
 
  -->
 
  -->
  
 +
Value set allows definition of an allowed set of values for any coded element.  It also supports the on-the-fly definition of code systems from which the content of those allowed values can be drawn.  Finally, it supports operations converting expression-based definitions of sets of codes into enumerated lists.  It includes support for all types of code systems - local and "standard", pre and post-coordinated, finite and infinite.
 
==RIM scope==
 
==RIM scope==
  
 
<!-- Identify the formal RIM mapping for the root concept of the resource.  The expectation is that the RIM mapping will be sufficiently precise so as to not overlap with any other resource definition. -->
 
<!-- Identify the formal RIM mapping for the root concept of the resource.  The expectation is that the RIM mapping will be sufficiently precise so as to not overlap with any other resource definition. -->
 +
 +
ValueSet is outside the RIM's scope, though the elements for a given code partially map to the ISO CD data type.  Value Sets are more appropriately mapped to the MIF.
  
 
==Resource appropriateness==
 
==Resource appropriateness==
 
 
<!-- Does the resource meet the following characteristics?
 
<!-- Does the resource meet the following characteristics?
  
Line 74: Line 74:
 
* Have the characteristics of high cohesion & low coupling – need to explore whether coupling is good some places, not elsewhere – layers from Bo’s document  
 
* Have the characteristics of high cohesion & low coupling – need to explore whether coupling is good some places, not elsewhere – layers from Bo’s document  
 
  -->
 
  -->
 +
 +
Shared value sets are essential to healthcare interoperability.  They have been in use within HL7 since v2 (though known as tables) and are a key part of HL7 v3.  Each value set is maintained indepenendently and has its own id which applies whether dealing with the expanded or unexpanded version of the value set. 
  
 
==Expected implementations==
 
==Expected implementations==
Line 80: Line 82:
  
 
==Content sources==
 
==Content sources==
 +
* HL7 v3 MIF
 +
* CTS 2
 +
* CDISC code lists
  
 
<!-- List all of the specifications (beyond those in the "standard" (FHIR_Design_Requirements_Sources) list of source specifications) that you’re planning to consult
 
<!-- List all of the specifications (beyond those in the "standard" (FHIR_Design_Requirements_Sources) list of source specifications) that you’re planning to consult
  
 
Are there any source specifications that you wish to consult but are concerned about access to or expertise to consider? -->
 
Are there any source specifications that you wish to consult but are concerned about access to or expertise to consider? -->
 +
 +
==Examples==
 +
All the value sets defined for the resources themselves should provide a sufficient set.
 +
 +
<!-- Provide a listing of the types of scenarios to be represented in the examples produced for this resource.  They should demonstrate the full scope of the resource and allow exercising of the resources capabilities (full element coverage, inclusion & omission of optional elements, repeating and singleton repeating elements, etc.) -->
  
 
==Resource Relationships==
 
==Resource Relationships==
 
 
<!-- What are the resources do you expect will reference this resource and in what context?
 
<!-- What are the resources do you expect will reference this resource and in what context?
  
Line 95: Line 104:
 
Reference to resources is really only relevant at the "same or higher level" (Bo – fix this wording)
 
Reference to resources is really only relevant at the "same or higher level" (Bo – fix this wording)
 
  -->
 
  -->
 +
Value Sets can include other ValueSet instances.  ValueSets are referenced by Profiles.  On occasion, a Coding might choose to reference the ValueSet (or expanded value set) it was drawn from via an extension.
 +
  
 
==Timelines==
 
==Timelines==
 
+
First DSTU
 
<!-- Indicate the target date for having the resource complete from a committee perspective and ready for vetting and voting -->
 
<!-- Indicate the target date for having the resource complete from a committee perspective and ready for vetting and voting -->
  
 
==gForge Users==
 
==gForge Users==
 
+
N/A
 
<!-- Identify the userids who will require commit access to gForge to maintain the resource.  (Ensure all users have registered for gForge.) -->
 
<!-- Identify the userids who will require commit access to gForge to maintain the resource.  (Ensure all users have registered for gForge.) -->

Revision as of 23:06, 27 May 2013



ValueSet

Owning committee name

YourCommitteeName

Contributing or Reviewing Work Groups

  • Work Group Name
  • or link
  • or "None"

FHIR Resource Development Project Insight ID

Pending

Scope of coverage

Value set allows definition of an allowed set of values for any coded element. It also supports the on-the-fly definition of code systems from which the content of those allowed values can be drawn. Finally, it supports operations converting expression-based definitions of sets of codes into enumerated lists. It includes support for all types of code systems - local and "standard", pre and post-coordinated, finite and infinite.

RIM scope

ValueSet is outside the RIM's scope, though the elements for a given code partially map to the ISO CD data type. Value Sets are more appropriately mapped to the MIF.

Resource appropriateness

Shared value sets are essential to healthcare interoperability. They have been in use within HL7 since v2 (though known as tables) and are a key part of HL7 v3. Each value set is maintained indepenendently and has its own id which applies whether dealing with the expanded or unexpanded version of the value set.

Expected implementations

Content sources

  • HL7 v3 MIF
  • CTS 2
  • CDISC code lists


Examples

All the value sets defined for the resources themselves should provide a sufficient set.


Resource Relationships

Value Sets can include other ValueSet instances. ValueSets are referenced by Profiles. On occasion, a Coding might choose to reference the ValueSet (or expanded value set) it was drawn from via an extension.


Timelines

First DSTU

gForge Users

N/A