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

Difference between revisions of "Profile 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=
+
=Profile=
  
 
<!-- 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]]
+
[[Conformance_and_Guidance_for_Implementation/Testing]]
 +
(temporarily owned by FHIR Core)
  
 
==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
+
* [[Templates]]
* or link
 
* or "None"
 
  
 
==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 55: Line 53:
 
As a rule, resources should encompass all of these aspects.
 
As a rule, resources should encompass all of these aspects.
 
  -->
 
  -->
 +
 +
Profile is used to define as well as to define constraints upon FHIR capabilities.  Specifically, it allows definition and constraint of: resources, data types, extensions, search criteria, messaging events, services, etc.  I.e. Any reuseable FHIR element
 +
 +
Profile subsumes the concepts of static messaging profile, template, detailed clinical model (DCM) and a large part of implementation guide.
 +
 +
Profile *excludes* defining combinations of features for a particular usage - that is left to the Conformance resource.
  
 
==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. -->
 +
 +
Profile exists outside the scope of the RIM as it deals with metadata rather than data.  It does have correspondence with MIF.
  
 
==Resource appropriateness==
 
==Resource appropriateness==
 +
Profiles, templates and DCMs are well understood concept in healthcare.  While they may have dependencies, they are each maintained separately.
  
 +
Profile is on the "large" size due to the large number of capabilities that can be defined within FHIR.
 
<!-- Does the resource meet the following characteristics?
 
<!-- Does the resource meet the following characteristics?
  
Line 76: Line 84:
  
 
==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. -->
+
FHIR uses Profile itself in representing resources and defining all extensions.  Profiles will also be used creating constraints of resources for in a variety of contexts such as equivalent of CDA templates and implementation guides, national program implementation guides, etc.
  
 
==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? -->
 +
 +
* HL7 v3 MIF
 +
* HL7 v2 static profile
 +
* HL7 template requirements
 +
* CDA Implemenation guides
 +
* Open EHR templates
 +
* CDISC ODM
 +
 +
==Examples==
 +
<!-- 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.) -->
 +
* All resource definitions are represented using Profile
 +
* Profile showing a chemistry lab panel
 +
* Profile showing definition of extensions, events and search criteria supplementing an existing resource
  
 
==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 115:
 
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)
 
  -->
 
  -->
 +
* Profile is used by Conformance to describe capabilities around messaging and documents.
 +
* Profiles can import other Profiles
 +
* Profiles reference ValueSet resources defining the constraints on their terminology elements
  
 
==Timelines==
 
==Timelines==
 
+
Initial 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.) -->
+
==Issues==
 +
* Should we split the "static" and "dynamic" aspects of Profile?  Do we need a way to define (and allow reference to) services & additional restful operations?

Revision as of 21:03, 27 May 2013



Profile

Owning committee name

Conformance_and_Guidance_for_Implementation/Testing (temporarily owned by FHIR Core)

Contributing or Reviewing Work Groups

FHIR Resource Development Project Insight ID

Pending

Scope of coverage

Profile is used to define as well as to define constraints upon FHIR capabilities. Specifically, it allows definition and constraint of: resources, data types, extensions, search criteria, messaging events, services, etc. I.e. Any reuseable FHIR element

Profile subsumes the concepts of static messaging profile, template, detailed clinical model (DCM) and a large part of implementation guide.

Profile *excludes* defining combinations of features for a particular usage - that is left to the Conformance resource.

RIM scope

Profile exists outside the scope of the RIM as it deals with metadata rather than data. It does have correspondence with MIF.

Resource appropriateness

Profiles, templates and DCMs are well understood concept in healthcare. While they may have dependencies, they are each maintained separately.

Profile is on the "large" size due to the large number of capabilities that can be defined within FHIR.

Expected implementations

FHIR uses Profile itself in representing resources and defining all extensions. Profiles will also be used creating constraints of resources for in a variety of contexts such as equivalent of CDA templates and implementation guides, national program implementation guides, etc.

Content sources

  • HL7 v3 MIF
  • HL7 v2 static profile
  • HL7 template requirements
  • CDA Implemenation guides
  • Open EHR templates
  • CDISC ODM

Examples

  • All resource definitions are represented using Profile
  • Profile showing a chemistry lab panel
  • Profile showing definition of extensions, events and search criteria supplementing an existing resource

Resource Relationships

  • Profile is used by Conformance to describe capabilities around messaging and documents.
  • Profiles can import other Profiles
  • Profiles reference ValueSet resources defining the constraints on their terminology elements

Timelines

Initial DSTU

gForge Users

N/A

Issues

  • Should we split the "static" and "dynamic" aspects of Profile? Do we need a way to define (and allow reference to) services & additional restful operations?