This wiki has undergone a migration to Confluence found Here

Difference between revisions of "Operation Outcome FHIR Resource Proposal"

From HL7Wiki
Jump to navigation Jump to search
(Created page with "{{subst::Template:FHIR Resource Proposal}}")
 
 
(4 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=
+
=OperationOutcome=
  
 
<!-- Resource names should meet the following characteristics:
 
<!-- Resource names should meet the following characteristics:
Line 29: Line 28:
 
==Owning committee name==
 
==Owning committee name==
  
 +
FHIR Core Team (eventually, InM)
 
<!-- 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]]
 
 
==Interested Work Groups==
 
  
 +
==Reviewing Work Groups==
 
<!-- Additional work groups that may have an interest in assisting with the content of the resource (optional) -->
 
<!-- Additional work groups that may have an interest in assisting with the content of the resource (optional) -->
* Work Group Name
+
InM
* or link
 
* or "None"
 
  
 
==FHIR Resource Development Project Insight ID==
 
==FHIR Resource Development Project Insight ID==
  
 +
None - FMG needs to do a PSS
 
<!-- 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==
 +
 +
Reflects both system level and business level issues (errors, warnings and information messages) resulting from some sort of system action on a FHIR resource or bundle of resources.  Encompasses such concepts as:
 +
* user doesn't have permission
 +
* internal database error
 +
* drug dose out of bounds
 +
* duplicate record
 +
 +
Note: Instances of this resource may be transient or persisted.
  
 
<!-- 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 57: Line 62:
  
 
==RIM scope==
 
==RIM scope==
 +
 +
* AcknowledgementDetail (system issues)
 +
* Observation[classCode="ALRT" and moodCode="EVN"] (business issues)
  
 
<!-- 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. -->
  
 
==Resource appropriateness==
 
==Resource appropriateness==
 +
 +
Base construct exists in most communication protocols that involve requesting an action.  Healthcare introduces specific types of healthcare issues such as contraindications.
 +
 +
Simple error responses might *not* have an identifier because they are only relevant in the context of a particular request and there is no need to persist them.  However, if there is a need to persist responses or if there's a need to track issues identified (and possibly managed) associated with a particular action, then they will be tracked and potentially queryable.
  
 
<!-- Does the resource meet the following characteristics?
 
<!-- Does the resource meet the following characteristics?
Line 76: Line 88:
  
 
==Expected implementations==
 
==Expected implementations==
 +
 +
Mandated as part of the response for "failure" when invoking REST operations.  May also be part of response for messages
  
 
<!-- For resources not deemed "key", what interest is there by implementers in using this particular resource.  (Should ideally have multiple independent implementations) -->
 
<!-- For resources not deemed "key", what interest is there by implementers in using this particular resource.  (Should ideally have multiple independent implementations) -->
  
 
==Content sources==
 
==Content sources==
 +
 +
* v2 ERR segment
 +
* v3 AcknowledgementDetail in Transmission wrappers
 +
* v3 DetectedIssue CMET
 +
* SOAP?
 +
* NCPDP?
 +
* Others?
  
 
<!-- 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? -->
 +
 +
==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.) -->
 +
 +
# RESTful query example reporting a database error with internal stack trace
 +
# Reporting an oAuth authentication failure
 +
# Reporting an un-managed drug-drug interaction
  
 
==Resource Relationships==
 
==Resource Relationships==
 +
 +
No relationships expected in core.  Some order resources might have links to OperationOutcome to identify issues associated with the order.  In extensions, an OperationOutcome might refer to resources relevant to the issue or even where the issue itself is defined.
  
 
<!-- 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 98: Line 129:
 
==Timelines==
 
==Timelines==
  
 +
Part of 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.) -->

Latest revision as of 05:45, 22 May 2014



OperationOutcome

Owning committee name

FHIR Core Team (eventually, InM)

Reviewing Work Groups

InM

FHIR Resource Development Project Insight ID

None - FMG needs to do a PSS

Scope of coverage

Reflects both system level and business level issues (errors, warnings and information messages) resulting from some sort of system action on a FHIR resource or bundle of resources. Encompasses such concepts as:

  • user doesn't have permission
  • internal database error
  • drug dose out of bounds
  • duplicate record

Note: Instances of this resource may be transient or persisted.


RIM scope

  • AcknowledgementDetail (system issues)
  • Observation[classCode="ALRT" and moodCode="EVN"] (business issues)


Resource appropriateness

Base construct exists in most communication protocols that involve requesting an action. Healthcare introduces specific types of healthcare issues such as contraindications.

Simple error responses might *not* have an identifier because they are only relevant in the context of a particular request and there is no need to persist them. However, if there is a need to persist responses or if there's a need to track issues identified (and possibly managed) associated with a particular action, then they will be tracked and potentially queryable.


Expected implementations

Mandated as part of the response for "failure" when invoking REST operations. May also be part of response for messages


Content sources

  • v2 ERR segment
  • v3 AcknowledgementDetail in Transmission wrappers
  • v3 DetectedIssue CMET
  • SOAP?
  • NCPDP?
  • Others?


Examples

  1. RESTful query example reporting a database error with internal stack trace
  2. Reporting an oAuth authentication failure
  3. Reporting an un-managed drug-drug interaction

Resource Relationships

No relationships expected in core. Some order resources might have links to OperationOutcome to identify issues associated with the order. In extensions, an OperationOutcome might refer to resources relevant to the issue or even where the issue itself is defined.


Timelines

Part of initial DSTU

gForge Users

N/A