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

Difference between revisions of "ExpansionProfile FHIR Resource Proposal"

From HL7Wiki
Jump to navigation Jump to search
 
(2 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
<div style="float: left;">[[Image:OpenHotTopic.GIF|35px| ]]</div>
 
<div style="float: left;">[[Image:OpenHotTopic.GIF|35px| ]]</div>
 
<div style="background:#F0F0F0">
 
<div style="background:#F0F0F0">
This page documents a [[:category:Pending FHIR Resource Proposal|Pending]] [[:category:FHIR Resource Proposal|FHIR Resource Proposal]]
+
This page documents a [[:category:Approved FHIR Resource Proposal|Approved]] [[:category:FHIR Resource Proposal|FHIR Resource Proposal]]
 
</div>
 
</div>
 
</div>
 
</div>
 
[[Category:FHIR Resource Proposal]]
 
[[Category:FHIR Resource Proposal]]
[[Category:Pending FHIR Resource Proposal]]
+
[[Category:Approved FHIR Resource Proposal]]
  
  
Line 22: Line 22:
  
 
<!-- Additional work groups that may have an interest in contributing to, or reviewing  the content of the resource (optional) -->
 
<!-- Additional work groups that may have an interest in contributing to, or reviewing  the content of the resource (optional) -->
* None
+
* CIMI
 +
* FHIR-Infrastructure
  
 
==FHIR Resource Development Project Insight ID==
 
==FHIR Resource Development Project Insight ID==
Line 60: Line 61:
 
* 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  
 
  -->
 
  -->
 +
 
The notion of Value Set Expansion profiles is not new to FHIR – it is explicitly supported in the FHIR Terminology Service Value Set Expansion operation. However, the support is limited to specifying a URI for an expansion profile without any way to define or represent the specific constraints. An ExpansionProfile will provide both a resource and a number of common constraints. This then enables implementers to represent, manage, and share the Value Set expansion profiling constraints as FHIR resources.  
 
The notion of Value Set Expansion profiles is not new to FHIR – it is explicitly supported in the FHIR Terminology Service Value Set Expansion operation. However, the support is limited to specifying a URI for an expansion profile without any way to define or represent the specific constraints. An ExpansionProfile will provide both a resource and a number of common constraints. This then enables implementers to represent, manage, and share the Value Set expansion profiling constraints as FHIR resources.  
 +
 +
Almost all users of $expand have already defined some profiling support in their implementation already. Vocab considered defining this earlier in the process, but delayed it in order to keep work load managable
  
 
==Expected implementations==
 
==Expected implementations==
 +
 
<!--Key resources are justified by CCDA, for resources not deemed "key", what interest is there by implementers in using this particular resource. Provide named implementations if possible - ideally provide multiple independent implementations. -->
 
<!--Key resources are justified by CCDA, for resources not deemed "key", what interest is there by implementers in using this particular resource. Provide named implementations if possible - ideally provide multiple independent implementations. -->
* The Australian/NEHTA National Clinical Terminology Service (NCTS) project.
+
* NEHTA / CSIRO (Australia) – National Clinical Terminology Service (NCTS) project
 +
* Health Intersections Server + Build tool internal $expand functionality
 +
* OHIE terminology server
  
 
==Content sources==
 
==Content sources==
 
<!-- 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? -->
* VSAC
+
* Value Set Authority Centre (VSAC)
 +
* NEHTA / CSIRO (Australia) – National Clinical Terminology Service (NCTS) project
 +
* Health Intersections Server / Telstra terminology server
 +
* Apelon server
 +
* CTS2
  
 
==Example Scenarios==
 
==Example Scenarios==
 +
<!-- 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.) -->
 +
* Restricting a ValueSet expansion to specific versions of code systems/terminologies
 +
* Including or excluding the definition of the ValueSet being expanded in the expansion
 +
* Enabling or disabling nesting of contains elements in ValueSet.expansion.contains
 +
* Including or excluding abstract concepts
 +
* Including or excluding specific designations
 +
* Specifying a language preference for ValueSet.expansion.contains.display elements
 +
* Specifying how the expand operation behaves when the expansion is too large i.e. return an error (OperationOutcome) or return a limited expansion and and indicator that the expansion is incomplete
 +
* Including or excluding post-coordinated codes in the expansion
  
<!-- 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 85: Line 103:
 
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)
 
  -->
 
  -->
 +
* This resource may be referenced as a value of the profile parameter of the Value Set Expansion operation
 +
* This resource may be included in ValueSet.expansion.parameter.value[x] – this would require a resource of type Reference to be supported 
 +
* this resource may have overlapping functionality with the value set resource (this would equate to specifying things at design time or run time; overlaps will be thoroughly reviewed)
  
 
==Timelines==
 
==Timelines==
 
+
2.1
<!-- Indicate the target date for having the resource complete from a committee perspective and ready for vetting and voting -->
 
  
 
==gForge Users==
 
==gForge Users==
 
 
<!-- 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.) -->
 +
* reuben_daniels
 +
* grahameg

Latest revision as of 22:31, 17 February 2016



ExpansionProfile

Owning committee name

Vocabulary

Contributing or Reviewing Work Groups

  • CIMI
  • FHIR-Infrastructure

FHIR Resource Development Project Insight ID

Pending

Scope of coverage

ExpansionProfile allows definition constraints on the Expansion of a FHIR ValueSet. For example, constraining the expansion to specific versions of code systems, or ensuring only specific designations are present. Finally, references to resources of this type may be used as values of the 'profile' parameter to explicitly request use of an ExpansionProfile resource through the FHIR Terminology Service Value Set expansion operation.

RIM scope

ExpansionProfile is outside the RIM's scope.

Resource appropriateness

The notion of Value Set Expansion profiles is not new to FHIR – it is explicitly supported in the FHIR Terminology Service Value Set Expansion operation. However, the support is limited to specifying a URI for an expansion profile without any way to define or represent the specific constraints. An ExpansionProfile will provide both a resource and a number of common constraints. This then enables implementers to represent, manage, and share the Value Set expansion profiling constraints as FHIR resources.

Almost all users of $expand have already defined some profiling support in their implementation already. Vocab considered defining this earlier in the process, but delayed it in order to keep work load managable

Expected implementations

  • NEHTA / CSIRO (Australia) – National Clinical Terminology Service (NCTS) project
  • Health Intersections Server + Build tool internal $expand functionality
  • OHIE terminology server

Content sources

  • Value Set Authority Centre (VSAC)
  • NEHTA / CSIRO (Australia) – National Clinical Terminology Service (NCTS) project
  • Health Intersections Server / Telstra terminology server
  • Apelon server
  • CTS2

Example Scenarios

  • Restricting a ValueSet expansion to specific versions of code systems/terminologies
  • Including or excluding the definition of the ValueSet being expanded in the expansion
  • Enabling or disabling nesting of contains elements in ValueSet.expansion.contains
  • Including or excluding abstract concepts
  • Including or excluding specific designations
  • Specifying a language preference for ValueSet.expansion.contains.display elements
  • Specifying how the expand operation behaves when the expansion is too large i.e. return an error (OperationOutcome) or return a limited expansion and and indicator that the expansion is incomplete
  • Including or excluding post-coordinated codes in the expansion


Resource Relationships

  • This resource may be referenced as a value of the profile parameter of the Value Set Expansion operation
  • This resource may be included in ValueSet.expansion.parameter.value[x] – this would require a resource of type Reference to be supported
  • this resource may have overlapping functionality with the value set resource (this would equate to specifying things at design time or run time; overlaps will be thoroughly reviewed)

Timelines

2.1

gForge Users

  • reuben_daniels
  • grahameg