This page is part of the FHIR Specification (v0.06: DSTU 1 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Resource IssueReport - Content 2.4

Status: Approved infrastructure resource. Draft for comment

Error, warning or information messages that result from a system action.

The resource name as it appears in a RESTful URL is /issuereport/

Issue Reports are sets of error, warning and information messages that describe that provide detailed information about the outcome of some attempted system activity. Most often they are provided as direct system responses, though they can also be used in other situations (see Notes).

Resource Content 2.4.1

<IssueReport xmlns="http://hl7.org/fhir">
 <issue>  <!-- 1..* A single issue associated with the action -->
  <severity><!-- 1..1 code Error, Warning or Information --></severity>
  <type><!-- 0..1 CodeableConcept Error or warning code --></type>
  <details><!-- 0..1 string Additional description of the issue --></details>
  <location><!-- 0..* string XPath of element(s) related to issue --></location>
 </issue>
 <extension><!-- 0..* Extension  See Extensions  --></extension>
 <text><!-- 1..1 Narrative Text summary of resource (for human interpretation) --></text>
</IssueReport>

Alternate definitions: Schema/Schematron, RDF (to do), XML, XMI (to do), Resource Profile

Terminology Bindings

Path	Details	Strength
IssueReport.issue.severity	How the issue affects the success of the action (see http://hl7.org/fhir/issue-severity for values)	complete/required
IssueReport.issue.type	A coded expression of the type of issue (not bound to any particular codes)	complete/unstated

Notes: 2.4.2

• When returned in response to a RESTful action, the issue might or might not be persisted and accessible by its own REST call. I.e. Issues can be created on the fly and returned without being otherwise accessible.

Open Issues 2.4.3

• It's not clear what, if any, search criteria are needed or appropriate.
• Is there a benefit to declaring a base set of detailed issue codes that apply across all types of requests that provide greater detail than HTTP response codes, or should the definition of error codes be left to profiles. (An intermediate step might be to define a code system with a starter set of recommended codes that could be drawn on by profiles.

Relationship with HTTP response codes 2.4.4

Issue resources are only relevant when a level of computable detail is required that is more granular than that provided by the HTTP response codes. This granularity could include:

• more detail about the location of an issue
• the ability to identify multiple distinct issues
• the need to drive automated behavior at a more detailed level than supported by HTTP codes and/or
• the need to return information with severities other than "failure"

Issue reports returned SHOULD be in alignment with the HTTP response code. For example, if the HTTP code indicates a failure, at least one of the issues should have a severity of "error", indicating the reason for the failure.

Use outside of responses 2.4.5

This resource may sometimes be used for purposes other than conveying the results of an attempted action. Examples include:

• Indicating acknowledged issues associated with another resource (e.g. a known drug-drug interaction associated with a prescription)
• Identifying possible issues associated with a resource (e.g. as part of a drug formulary)
• Pro-actively acknowledging known issues as part of a request so as to allow a desired action to proceed despite the existence of the problem (i.e. as an override)

Search Parameters 2.4.6

Search Parameters for RESTful searches. The standard parameters also apply. See Searching for more information.

$page : integer	Starting offset of the first record to return in the search set	single
$count : integer	Number of return records requested. The server is not bound to conform	single
$id : token	The logical resource id associated with the resource (must be supported by all servers)	single

(See Searching).

---

This is an old version of FHIR retained for archive purposes. Do not use for anything else
Implementers are welcome to experiment with the content defined here, but should note that the contents are subject to change without prior notice.
© HL7.org 2011 - 2012. FHIR v0.06 generated on Tue, Dec 4, 2012 00:03+1100. License