This wiki has undergone a migration to Confluence found Here
Difference between revisions of "ExpansionProfile FHIR Resource Proposal"
Jump to navigation
Jump to search
| 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) --> | ||
| − | * | + | * 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. --> | ||
* NEHTA / CSIRO (Australia) – 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== | ||
| Line 71: | Line 78: | ||
* Value Set Authority Centre (VSAC) | * Value Set Authority Centre (VSAC) | ||
* NEHTA / CSIRO (Australia) – National Clinical Terminology Service (NCTS) project | * NEHTA / CSIRO (Australia) – National Clinical Terminology Service (NCTS) project | ||
| + | * Health Intersections Server / Telstra terminology server | ||
| + | * Apelon server | ||
| + | * CTS2 | ||
==Example Scenarios== | ==Example Scenarios== | ||
| Line 95: | Line 105: | ||
* This resource may be referenced as a value of the profile parameter of the Value Set Expansion operation | * 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 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== | ||
Revision as of 11:37, 29 October 2015
This page documents a Pending FHIR Resource Proposal
Contents
- 1 ExpansionProfile
- 1.1 Owning committee name
- 1.2 Contributing or Reviewing Work Groups
- 1.3 FHIR Resource Development Project Insight ID
- 1.4 Scope of coverage
- 1.5 RIM scope
- 1.6 Resource appropriateness
- 1.7 Expected implementations
- 1.8 Content sources
- 1.9 Example Scenarios
- 1.10 Resource Relationships
- 1.11 Timelines
- 1.12 gForge Users
ExpansionProfile
Owning committee name
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
