This page is part of the FHIR Specification (v1.4.0:
STU
3 Ballot 3). The current version which supercedes this version is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
. For a full list of available versions, see the
Directory of published versions
.
Page
versions:
. Page versions:
R5
R4B
R4
R3
R2
|
|
Compartments
|
Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.
This resource applies to various circumstances where there is a concern about an existing or proposed set of clinical activity. The issue could relate to single, proposed, or multiple actions. It does not apply to technical issues (e.g. lack of user permissions) but could relate to violation of patient consent limitations. Examples include:
This resource represents a specific instance of a potential issue for a particular patient. It is
not
intended
to
represent
general
patient-independent
knowledge.
This
resource
is
also
intended to represent general patient-independent knowledge. This resource is also
not
intended
to
be
used
in
defining
general
prohibitions
on
actions
such
as
"No
NSAIDs",
"No
solid
oral
dose
forms"
or
"No
MRIs
-
metalic
tatoos".
These
guidelines
can
be
captured
using
the
intended to be used in defining general prohibitions on actions such as "No NSAIDs", "No solid oral dose forms" or "No MRIs - metalic tatoos". These guidelines can be captured using the
AllergyIntolerance
,
and/or
, and/or
Flag
resources.
Similarly
this
resource
is
not
to
be
used
to
capture
clinical
facts
that
may
imply
contraindications
such
as
pregnancy,
breast
feeding,
patient
preferences,
past
procedures,
etc.
These
would
be
represented
using
resources. Similarly this resource is not to be used to capture clinical facts that may imply contraindications such as pregnancy, breast feeding, patient preferences, past procedures, etc. These would be represented using
Condition
,
,
Procedure
or
other
resources.
or other resources.
This resource only applies to documenting a risk associated with a specific planned or ongoing action, not a general propensity to risk. The latter would be handled using
AllergyIntolerance
for
substance-specific
issues
or
for substance-specific issues or
Flag
for
other
types
of
issues.
This
resource
is
limited
to
clinical
issues
associated
with
a
proposed
or
ongoing
action.
It
does
not
cover
technical
issues
such
as
lack
of
permission,
duplicate
identifiers
and
other
business
rule
violations.
Technical
issues
are
conveyed
using
the
OperationOutcome
resource.
It
is
possible
to
have
both
for other types of issues.
This resource is limited to clinical issues associated with a proposed or ongoing action. It does not cover technical issues such as lack of permission, duplicate identifiers and other business rule violations. Technical issues are conveyed using the
OperationOutcome
and
DetectedIssue
together,
where
the
resource. It is possible to have both
OperationOutcome
might
indicate
that
a
requested
action
was
rejected
due
to
a
clinical
issue
and
the
and
DetectedIssue
together, where the OperationOutcome might indicate that a requested action was rejected due to a clinical issue and the DetectedIssue provides the details of the issue.
provides
the
details
of
the
issue.
Detected issues are typically identified by decision support systems. However, they may also be captured directly by clinicians. The latter typically happens for one of two reasons:
Decision-support generated issues can result from calling a decision-support engine directly (e.g. via a custom
OperationDefinition
)
or
as
part
of
an
attempt
to
perform
some
other
function
(creating
an
order,
submitting
an
insurance
claim,
capturing
a
medication
list).
When
the
issues
are
generated
as
a
byproduct
of
performing
some
other
sort
of
action,
they
may
be
included
in
the
"response"
to
the
requested
action
in
the
same
manner
as
an
) or as part of an attempt to perform some other function (creating an order, submitting an insurance claim, capturing a medication list). When the issues are generated as a byproduct of performing some other sort of action, they may be included in the "response" to the requested action in the same manner as an
OperationOutcome
.
In
fact,
both
may
be
present
-
the
. In fact, both may be present - the
OperationOutcome
indicating
that
there
was
a
warning
or
error
associated
with
the
request
and
a
indicating that there was a warning or error associated with the request and a
DetectedIssue
providing
the
clinical
details.
(The
providing the clinical details. (The
OperationOutcome
could
point
to
the
could point to the
DetectedIssue
via
an
extension.)
In
those
circumstances
where
requested
operations
are
rejected
as
a
result
of
a
detected
issue,
the
workflow
may
support
allowing
the
operation
to
be
re-tried,
provided
that
the
identified
issue
is
included
as
part
of
the
submission
(possibly
also
including
a
mitigation).
In
doing
so,
the
sender
acknowledges
the
issue
and
takes
responsibility
for
it,
thus
allowing
the
requested
operation
to
proceed.
See
Linking
to
Detected
Issues
for
guidance
on
how
a
via an extension.)
In those circumstances where requested operations are rejected as a result of a detected issue, the workflow may support allowing the operation to be re-tried, provided that the identified issue is included as part of the submission (possibly also including a mitigation). In doing so, the sender acknowledges the issue and takes responsibility for it, thus allowing the requested operation to proceed. See
Linking to Detected Issues
for guidance on how a
DetectedIssue
instance
might
be
included
as
part
of
another
operation.
Systems
that
require
such
workflows
should
document
expected
behavior
as
part
of
their
instance might be included as part of another operation.
Systems that require such workflows should document expected behavior as part of their
Conformance
declarations.
declarations.
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
DomainResource |
|
||
|
Σ | 0..1 | Reference ( Patient ) |
|
|
Σ | 0..1 | CodeableConcept |
|
|
Σ | 0..1 | code |
DetectedIssueSeverity |
|
Σ | 0..* | Reference ( Any ) |
|
|
0..1 | string |
|
|
|
Σ | 0..1 | dateTime |
|
|
Σ | 0..1 |
Reference
(
Practitioner
|
|
|
Σ | 0..1 | Identifier |
|
|
0..1 | uri |
|
|
|
0..* | BackboneElement |
|
|
|
1..1 | CodeableConcept |
|
|
|
0..1 | dateTime |
|
|
|
0..1 | Reference ( Practitioner ) |
|
|
Documentation for this format
|
||||
UML
Diagram
UML Diagram
XML
Template
XML Template
<DetectedIssue xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <patient><!-- 0..1 Reference(Patient) Associated patient --></patient> <category><!-- 0..1 CodeableConcept Issue Category, e.g. drug-drug, duplicate therapy, etc. --></category> <severity value="[code]"/><!-- 0..1 high | moderate | low --> <implicated><!-- 0..* Reference(Any) Problem resource --></implicated> <detail value="[string]"/><!-- 0..1 Description and context --> <date value="[dateTime]"/><!-- 0..1 When identified --> <author><!-- 0..1 Reference(Practitioner|Device) The provider or device that identified the issue --></author> <identifier><!-- 0..1 Identifier Unique id for the detected issue --></identifier> <reference value="[uri]"/><!-- 0..1 Authority for issue --> <mitigation> <!-- 0..* Step taken to address --> <action><!-- 1..1 CodeableConcept What mitigation? --></action> <date value="[dateTime]"/><!-- 0..1 Date committed --> <author><!-- 0..1 Reference(Practitioner) Who is committing? --></author> </mitigation> </DetectedIssue>
JSON
Template
JSON Template
{
"resourceType" : "DetectedIssue",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"patient" : { Reference(Patient) }, // Associated patient
"category" : { CodeableConcept }, // Issue Category, e.g. drug-drug, duplicate therapy, etc.
"severity" : "<code>", // high | moderate | low
"implicated" : [{ Reference(Any) }], // Problem resource
"detail" : "<string>", // Description and context
"date" : "<dateTime>", // When identified
"author" : { Reference(Practitioner|Device) }, // The provider or device that identified the issue
"identifier" : { Identifier }, // Unique id for the detected issue
"reference" : "<uri>", // Authority for issue
"mitigation" : [{ // Step taken to address
"action" : { CodeableConcept }, // R! What mitigation?
"date" : "<dateTime>", // Date committed
"author" : { Reference(Practitioner) } // Who is committing?
}]
}
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
DomainResource |
|
||
|
Σ | 0..1 | Reference ( Patient ) |
|
|
Σ | 0..1 | CodeableConcept |
|
|
Σ | 0..1 | code |
DetectedIssueSeverity |
|
Σ | 0..* | Reference ( Any ) |
|
|
0..1 | string |
|
|
|
Σ | 0..1 | dateTime |
|
|
Σ | 0..1 |
Reference
(
Practitioner
|
|
|
Σ | 0..1 | Identifier |
|
|
0..1 | uri |
|
|
|
0..* | BackboneElement |
|
|
|
1..1 | CodeableConcept |
|
|
|
0..1 | dateTime |
|
|
|
0..1 | Reference ( Practitioner ) |
|
|
Documentation for this format
|
||||
XML
Template
XML Template
<DetectedIssue xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <patient><!-- 0..1 Reference(Patient) Associated patient --></patient> <category><!-- 0..1 CodeableConcept Issue Category, e.g. drug-drug, duplicate therapy, etc. --></category> <severity value="[code]"/><!-- 0..1 high | moderate | low --> <implicated><!-- 0..* Reference(Any) Problem resource --></implicated> <detail value="[string]"/><!-- 0..1 Description and context --> <date value="[dateTime]"/><!-- 0..1 When identified --> <author><!-- 0..1 Reference(Practitioner|Device) The provider or device that identified the issue --></author> <identifier><!-- 0..1 Identifier Unique id for the detected issue --></identifier> <reference value="[uri]"/><!-- 0..1 Authority for issue --> <mitigation> <!-- 0..* Step taken to address --> <action><!-- 1..1 CodeableConcept What mitigation? --></action> <date value="[dateTime]"/><!-- 0..1 Date committed --> <author><!-- 0..1 Reference(Practitioner) Who is committing? --></author> </mitigation> </DetectedIssue>
JSON
Template
JSON Template
{
"resourceType" : "DetectedIssue",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"patient" : { Reference(Patient) }, // Associated patient
"category" : { CodeableConcept }, // Issue Category, e.g. drug-drug, duplicate therapy, etc.
"severity" : "<code>", // high | moderate | low
"implicated" : [{ Reference(Any) }], // Problem resource
"detail" : "<string>", // Description and context
"date" : "<dateTime>", // When identified
"author" : { Reference(Practitioner|Device) }, // The provider or device that identified the issue
"identifier" : { Identifier }, // Unique id for the detected issue
"reference" : "<uri>", // Authority for issue
"mitigation" : [{ // Step taken to address
"action" : { CodeableConcept }, // R! What mitigation?
"date" : "<dateTime>", // Date committed
"author" : { Reference(Practitioner) } // Who is committing?
}]
}
Alternate
definitions:
Alternate definitions:
Schema
/
Schematron
,
Resource
Profile
(
, Resource Profile (
XML
,
,
JSON
),
),
Questionnaire
| Path | Definition | Type | Reference |
|---|---|---|---|
|
|
|
Preferred |
|
|
|
|
Required | DetectedIssueSeverity |
|
|
|
Preferred |
|
DetectedIssue follows the pattern of linking from the resource created "second". As DetectedIssue originates in response to one or more other existing records, it points to those records rather than being pointed to from them.
In some cases, a detected issue might be associated with a single record. When this occurs, it may be stored as a contained resource within the implicated resource provided that there is no expected need to search for the detected issue directly. However, with detected issues that implicate multiple records, containment is more problematic. In some workflows, a detected issue might be deemed to be "owned" by the record whose creation triggers the contraindication being created - i.e. the "second" or "last" record. However, where multiple actions are proposed as part of a single submission, there can be no single owner and containment will not be feasible.
If there is a strong need to point from an implicated resource to DetectedIssue and containment is not appropriate, an extension can be used.
DetectedIssue is a resource that is frequently associated with workflow challenges where frequent alerts that are not clinically relevant result in clinicians tuning out (or turning off) the content and thus missing relevant alerts. Give consideration to this issue before making heavy use of this resource.
Search parameters for this resource. The
common parameters
also apply. See
Searching
for
more
information
about
searching
in
REST,
messaging,
and
services.
for more information about searching in REST, messaging, and services.
| Name | Type | Description | Paths |
| author | reference |
|
DetectedIssue.author
( Device |
| category | token |
|
DetectedIssue.category |
| date | date |
|
DetectedIssue.date |
| identifier | token |
|
DetectedIssue.identifier |
| implicated | reference |
|
DetectedIssue.implicated
(Any) |
| patient | reference |
|
DetectedIssue.patient
( Patient ) |