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
 
(3 intermediate revisions by one other user not shown)
Line 2: Line 2:
 
<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 12: Line 12:
  
  
=IssueReport=
+
=OperationOutcome=
  
 
<!-- Resource names should meet the following characteristics:
 
<!-- Resource names should meet the following characteristics:
Line 30: Line 30:
 
FHIR Core Team (eventually, InM)
 
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]]
 
  
 
==Reviewing Work Groups==
 
==Reviewing Work Groups==
Line 73: Line 72:
 
Base construct exists in most communication protocols that involve requesting an action.  Healthcare introduces specific types of healthcare issues such as contraindications.
 
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 repsonses 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.
+
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 106: Line 105:
  
 
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 IssueReport to identify issues associated with the order.  In extensions, an IssueReport might refer to resources relevant to the issue or even where the issue itself is defined.
+
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?

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