This wiki has undergone a migration to Confluence found Here

Difference between revisions of "Conformance FHIR Resource Proposal"

From HL7Wiki
Jump to navigation Jump to search
(Created page with "{{subst::Template:FHIR Resource Proposal}}")
 
 
(3 intermediate revisions by 2 users 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=
+
=Conformance=
  
 
<!-- 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]] (CGIT)
 +
* Temporarily owned by the 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
+
* [[Infrastructure_and_Messaging]] (InM)
* or link
+
* [[Service_Oriented_Architecture]] (SOA)
* 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 -->
  
Line 55: Line 55:
 
As a rule, resources should encompass all of these aspects.
 
As a rule, resources should encompass all of these aspects.
 
  -->
 
  -->
 +
 +
The resource is used to represent '''all''' conformance declarations with FHIR that fall within the scope of the FHIR specification.  Specifically:
 +
* It covers conformance declarations across the messaging, document and services paradigms
 +
* It covers conformance declarations of installed, designed and proposed systems (whether composed of multiple components or stand-alone)
 +
* It covers both "full" conformance and any specification-recognized "partial" conformance within the scope of use
 +
 +
Systems cannot legitimately declare conformance with FHIR unless they are accompanied by a valid instance of this resource.
 +
 +
Note: This resources does '''not''' cover conformance declarations for out-of-scope uses.  E.g. FHIR as an internal database model, FHIR as an internal model for decision-support purposes, etc.
  
 
==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. -->
 +
This resource operates outside of the space covered by the RIM as "meta" information about FHIR-conformant systems.  It will have mappings to the v2 conformance model and portions of the v3 MIF.
  
 
==Resource appropriateness==
 
==Resource appropriateness==
Line 74: Line 84:
 
* 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  
 
  -->
 
  -->
 +
Conformance declaration has been identified as important in v2 and relevant in v3.  It is particularly important for discoverability in RESTful solutions.  Conformance statements represent distinct installations, software systems and software requirement statements and thus meet the requirement of independence.  The number of data elements is on the high side due to the need to capture information on a variety of different interoperability types, however the types need to be combined because the overall conformance statement acts as a single unit.
  
 
==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. -->
 +
All implementations declaring conformance to FHIR will need to implement this resource.
  
 
==Content sources==
 
==Content sources==
Line 84: Line 96:
  
 
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 v2 conformance profiles
 +
* HL7 v3 MIF conformance statement
 +
* IHE Implementation guides
 +
 +
==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.) -->
 +
 +
# One instance each from an RFP perspective describing document requirements
 +
# A configurable application describing RESTful, document and messaging capabilities
 +
# An installed application describing a document configuration
  
 
==Resource Relationships==
 
==Resource Relationships==
Line 95: Line 118:
 
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)
 
  -->
 
  -->
 +
No resources are expected to reference Conformance statements, at least not within the 80%.
 +
 +
Conformance will reference the Profile resource to allow identification of the constraints and packaging expectations supported for messaging and documents
  
 
==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 -->
 +
This is a core resource that will be part of the 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
 +
 +
==Issues==
 +
* Do we need a PSS for this?
 +
* Should this resource be used for declaration of conformance for SOA FHIR solutions as well, and if so, what would that look like?
 +
* Are there additional sources we can/should look to for examples of Conformance

Latest revision as of 05:37, 22 May 2014



Conformance

Owning committee name

Conformance_and_Guidance_for_Implementation/Testing (CGIT)

  • Temporarily owned by the FHIR Core Team

Contributing or Reviewing Work Groups

FHIR Resource Development Project Insight ID

Pending

Scope of coverage

The resource is used to represent all conformance declarations with FHIR that fall within the scope of the FHIR specification. Specifically:

  • It covers conformance declarations across the messaging, document and services paradigms
  • It covers conformance declarations of installed, designed and proposed systems (whether composed of multiple components or stand-alone)
  • It covers both "full" conformance and any specification-recognized "partial" conformance within the scope of use

Systems cannot legitimately declare conformance with FHIR unless they are accompanied by a valid instance of this resource.

Note: This resources does not cover conformance declarations for out-of-scope uses. E.g. FHIR as an internal database model, FHIR as an internal model for decision-support purposes, etc.

RIM scope

This resource operates outside of the space covered by the RIM as "meta" information about FHIR-conformant systems. It will have mappings to the v2 conformance model and portions of the v3 MIF.

Resource appropriateness

Conformance declaration has been identified as important in v2 and relevant in v3. It is particularly important for discoverability in RESTful solutions. Conformance statements represent distinct installations, software systems and software requirement statements and thus meet the requirement of independence. The number of data elements is on the high side due to the need to capture information on a variety of different interoperability types, however the types need to be combined because the overall conformance statement acts as a single unit.

Expected implementations

All implementations declaring conformance to FHIR will need to implement this resource.

Content sources

  • HL7 v2 conformance profiles
  • HL7 v3 MIF conformance statement
  • IHE Implementation guides

Examples

  1. One instance each from an RFP perspective describing document requirements
  2. A configurable application describing RESTful, document and messaging capabilities
  3. An installed application describing a document configuration

Resource Relationships

No resources are expected to reference Conformance statements, at least not within the 80%.

Conformance will reference the Profile resource to allow identification of the constraints and packaging expectations supported for messaging and documents

Timelines

This is a core resource that will be part of the initial DSTU

gForge Users

N/A

Issues

  • Do we need a PSS for this?
  • Should this resource be used for declaration of conformance for SOA FHIR solutions as well, and if so, what would that look like?
  • Are there additional sources we can/should look to for examples of Conformance