This wiki has undergone a migration to Confluence found Here

Difference between revisions of "Other FHIR Resource Proposal"

From HL7Wiki
Jump to navigation Jump to search
(Created page with "{{subst::Template:FHIR Resource Proposal}}")
 
 
(3 intermediate revisions by one other user not shown)
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>
 
<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 an [[: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 13: Line 12:
  
  
=PutProposedResourceNameHere=
+
=Other=
  
 
<!-- Resource names should meet the following characteristics:
 
<!-- Resource names should meet the following characteristics:
Line 30: Line 29:
  
 
<!-- The name of the committee that is proposed to have responsibility for developing and maintaining the resources. -->
 
<!-- The name of the committee that is proposed to have responsibility for developing and maintaining the resources. -->
[[YourCommitteeName]]
+
FHIR Core Team
  
 
==Contributing or Reviewing Work Groups==
 
==Contributing or Reviewing Work Groups==
  
 
<!-- 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) -->
* Work Group Name
+
* None
* or link
 
* or "None"
 
  
 
==FHIR Resource Development Project Insight ID==
 
==FHIR Resource Development Project Insight ID==
  
 
<!-- 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 -->
 +
Pending
  
 
==Scope of coverage==
 
==Scope of coverage==
Line 55: Line 53:
 
As a rule, resources should encompass all of these aspects.
 
As a rule, resources should encompass all of these aspects.
 
  -->
 
  -->
 +
This is <b>not</b> a typical resource in that it doesn't have a bounded set of semantics.
 +
 +
The Other resource is intended to cover all use-cases not met by HL7-defined resources.  This includes resources that HL7 intends to create as well as those that are outside the scope of what HL7 will define.  The scope of this resource will evolve as additional resources are defined.
 +
 +
This resource provides a mechanism for implementers to implement "custom" resources while still falling within the bounds of FHIR conformance, avoiding issues with collisions and ensuring that the meaning of elements within the resource remains discoverable.
 +
 +
The time-frame for migration from the Other resource to official HL7-defined resources is up to implementers.
  
 
==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. -->
 +
InfrastructureRoot
  
 
==Resource appropriateness==
 
==Resource appropriateness==
Line 74: Line 80:
 
* 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 primary purpose of this resource is to provide a safety valve for implementers where they have requirements not met by the existing FHIR specification.  Extensibility is a key part of the FHIR methodology, including at the resource level.  The is resource is different from others in that it isn't linked to a single concept.  Instead, the concept represented by the resource is defined by an HL7-specific terminology (extensible for local use).
  
 
==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 need for additional as-yet undefined resources is well recognized.  Existing implementers are already encountering it.
  
 
==Content sources==
 
==Content sources==
Line 84: Line 92:
  
 
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? -->
 +
The initial vocabulary for Other resource types will be taken from the set of candidate resources identified on the wiki
  
 
==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.) -->
 
<!-- 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.) -->
 +
The set of examples will need to be updated over time as new resources are defined.
 +
* Referral
 +
* UML diagram
  
 
==Resource Relationships==
 
==Resource Relationships==
Line 99: Line 111:
 
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)
 
  -->
 
  -->
 +
* Link to Patient (as subject) and Practitioner (as author)
 +
* Can link to any other resources via extensions
  
 
==Timelines==
 
==Timelines==
  
 
<!-- 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 -->
 +
Included in initial DSTU
  
 
==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.) -->
 +
N/A

Latest revision as of 05:46, 22 May 2014



Other

Owning committee name

FHIR Core Team

Contributing or Reviewing Work Groups

  • None

FHIR Resource Development Project Insight ID

Pending

Scope of coverage

This is not a typical resource in that it doesn't have a bounded set of semantics.

The Other resource is intended to cover all use-cases not met by HL7-defined resources. This includes resources that HL7 intends to create as well as those that are outside the scope of what HL7 will define. The scope of this resource will evolve as additional resources are defined.

This resource provides a mechanism for implementers to implement "custom" resources while still falling within the bounds of FHIR conformance, avoiding issues with collisions and ensuring that the meaning of elements within the resource remains discoverable.

The time-frame for migration from the Other resource to official HL7-defined resources is up to implementers.

RIM scope

InfrastructureRoot

Resource appropriateness

The primary purpose of this resource is to provide a safety valve for implementers where they have requirements not met by the existing FHIR specification. Extensibility is a key part of the FHIR methodology, including at the resource level. The is resource is different from others in that it isn't linked to a single concept. Instead, the concept represented by the resource is defined by an HL7-specific terminology (extensible for local use).

Expected implementations

The need for additional as-yet undefined resources is well recognized. Existing implementers are already encountering it.

Content sources

The initial vocabulary for Other resource types will be taken from the set of candidate resources identified on the wiki

Example Scenarios

The set of examples will need to be updated over time as new resources are defined.

  • Referral
  • UML diagram

Resource Relationships

  • Link to Patient (as subject) and Practitioner (as author)
  • Can link to any other resources via extensions

Timelines

Included in initial DSTU

gForge Users

N/A