This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
(v4.0.1:
R4
-
Mixed
Normative
and
STU
3).
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R4
R3
R2
Clinical
Decision
Support
Work
Group
|
Maturity Level : 1 | Trial Use | Security Category : Patient | Compartments : Device , Patient , Practitioner |
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 is an event resource from a FHIR workflow perspective - see Workflow , specifically Event .
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
not
intended
to
be
used
in
defining
general
prohibitions
on
actions
such
as
"No
NSAIDs",
"No
"No
NSAIDs",
"No
solid
oral
dose
forms"
forms"
or
"No
"No
MRIs
-
metalic
tatoos".
metallic
tattoos".
These
guidelines
can
be
captured
using
the
AllergyIntolerance
,
and/or
Flag
resources.
Similarly
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.
This resource only applies to documenting a risk associated with a specific planned or ongoing action, or the lack of an action which should be planned - not a general propensity to risk. The latter would be handled using AllergyIntolerance for substance-specific issues or Flag for other types of issues. In addition, the resource represents patient-specific and time-bound risk manifestations, not generic knowledge statements about risks that can exist.
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
identifiers,
insufficient
data,
and
other
business
rule
violations.
Technical
issues
are
conveyed
using
the
OperationOutcome
resource.
It
is
possible
to
have
both
OperationOutcome
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.
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
by-product
of
performing
some
other
sort
of
action,
they
may
be
included
in
the
"response"
"response"
to
the
requested
action
in
the
same
manner
as
an
OperationOutcome
.
In
fact,
both
may
be
present
-
the
OperationOutcome
indicating
that
there
was
a
warning
or
error
associated
with
the
request
and
a
DetectedIssue
providing
the
clinical
details.
(The
OperationOutcome
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 DetectedIssue instance might be included as part of another operation.
Systems that require such workflows should document expected behavior as part of their CapabilityStatement declarations.
This resource is referenced by MedicationDispense , MedicationKnowledge and MedicationRequest
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
Clinical
issue
with
action
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
Unique
id
for
the
detected
issue
|
|
?! Σ | 1..1 | code |
registered
|
preliminary
|
final
|
amended
+
ObservationStatus ( Required ) |
|
Σ | 0..1 | CodeableConcept |
Issue
Category,
e.g.
drug-drug,
duplicate
therapy,
etc.
Detected Issue Category ( Preferred ) |
|
Σ | 0..1 | code |
high
|
moderate
|
low
DetectedIssueSeverity ( Required ) |
|
Σ | 0..1 | Reference ( Patient ) | Associated patient |
|
Σ | 0..1 | When identified | |
![]() ![]() ![]() | dateTime | |||
| Period | |||
|
Σ | 0..1 | Reference ( Practitioner | PractitionerRole | Device ) | The provider or device that identified the issue |
|
Σ | 0..* | Reference ( Any ) |
Problem
resource
|
| 0..* | BackboneElement |
Supporting
evidence
| |
![]() ![]() ![]() | 0..* | CodeableConcept |
Manifestation
Manifestation and Symptom Codes ( Example ) | |
![]() ![]() ![]() | 0..* | Reference ( Any ) |
Supporting
information
| |
|
0..1 | string | Description and context | |
|
0..1 | uri | Authority for issue | |
|
0..* | BackboneElement |
Step
taken
to
address
|
|
|
1..1 | CodeableConcept |
What
mitigation?
Detected Issue Mitigation Action ( Preferred ) |
|
|
0..1 | dateTime | Date committed | |
|
0..1 | Reference ( Practitioner | PractitionerRole ) | Who is committing? | |
Documentation
for
this
format
|
||||
UML Diagram ( Legend )
XML Template
<<DetectedIssue xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier> < <</category> <<identifier><!-- 0..* Identifier Unique id for the detected issue --></identifier> <status value="[code]"/><!-- 1..1 registered | preliminary | final | amended + --> <code><!-- 0..1 CodeableConcept Issue Category, e.g. drug-drug, duplicate therapy, etc. --></code> <severity value="[code]"/><!-- 0..1 high | moderate | low --> <patient><!-- 0..1 Reference(Patient) Associated patient --></patient>< <</author><identified[x]><!-- 0..1 dateTime|Period When identified --></identified[x]> <author><!-- 0..1 Reference(Practitioner|PractitionerRole|Device) The provider or device that identified the issue --></author> <implicated><!-- 0..* Reference(Any) Problem resource --></implicated>< < <<evidence> <!-- 0..* Supporting evidence --> <code><!-- 0..* CodeableConcept Manifestation --></code> <detail><!-- 0..* Reference(Any) Supporting information --></detail> </evidence> <detail value="[string]"/><!-- 0..1 Description and context --> <reference value="[uri]"/><!-- 0..1 Authority for issue --> <mitigation> <!-- 0..* Step taken to address --> <action><!-- 1..1 CodeableConcept What mitigation? --></action>< <</author><date value="[dateTime]"/><!-- 0..1 Date committed --> <author><!-- 0..1 Reference(Practitioner|PractitionerRole) Who is committing? --></author> </mitigation> </DetectedIssue>
JSON Template
{
"resourceType" : "",
"resourceType" : "DetectedIssue",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"identifier" : [{ Identifier }], // Unique id for the detected issue
"status" : "<code>", // R! registered | preliminary | final | amended +
"code" : { CodeableConcept }, // Issue Category, e.g. drug-drug, duplicate therapy, etc.
"severity" : "<code>", // high | moderate | low
"patient" : { Reference(Patient) }, // Associated patient
// identified[x]: When identified. One of these 2:
"identifiedDateTime" : "<dateTime>",
"identifiedPeriod" : { Period },
"author" : { Reference(Practitioner|PractitionerRole|Device) }, // The provider or device that identified the issue
"implicated" : [{ Reference(Any) }], // Problem resource
"evidence" : [{ // Supporting evidence
"code" : [{ CodeableConcept }], // Manifestation
"detail" : [{ Reference(Any) }] // Supporting information
}],
"detail" : "<string>", // Description and context
"reference" : "<uri>", // Authority for issue
"mitigation" : [{ // Step taken to address
"action" : { CodeableConcept }, // R! What mitigation?
"date" : "<dateTime>", // Date committed
"author" : { Reference(Practitioner|PractitionerRole) } // Who is committing?
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:DetectedIssue; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension
fhir:fhir:DetectedIssue.identifier [ Identifier ], ... ; # 0..* Unique id for the detected issue fhir:DetectedIssue.status [ code ]; # 1..1 registered | preliminary | final | amended +fhir:fhir:DetectedIssue.code [ CodeableConcept ]; # 0..1 Issue Category, e.g. drug-drug, duplicate therapy, etc. fhir:DetectedIssue.severity [ code ]; # 0..1 high | moderate | low fhir:DetectedIssue.patient [ Reference(Patient) ]; # 0..1 Associated patientfhir: fhir:# DetectedIssue.identified[x] : 0..1 When identified. One of these 2 fhir:DetectedIssue.identifiedDateTime [ dateTime ] fhir:DetectedIssue.identifiedPeriod [ Period ] fhir:DetectedIssue.author [ Reference(Practitioner|PractitionerRole|Device) ]; # 0..1 The provider or device that identified the issue fhir:DetectedIssue.implicated [ Reference(Any) ], ... ; # 0..* Problem resource fhir:DetectedIssue.evidence [ # 0..* Supporting evidence fhir:DetectedIssue.evidence.code [ CodeableConcept ], ... ; # 0..* Manifestation fhir:DetectedIssue.evidence.detail [ Reference(Any) ], ... ; # 0..* Supporting information ], ...; fhir:DetectedIssue.detail [ string ]; # 0..1 Description and context fhir:DetectedIssue.reference [ uri ]; # 0..1 Authority for issuefhir:fhir:DetectedIssue.mitigation [ # 0..* Step taken to address fhir:DetectedIssue.mitigation.action [ CodeableConcept ]; # 1..1 What mitigation? fhir:DetectedIssue.mitigation.date [ dateTime ]; # 0..1 Date committedfhir:fhir:DetectedIssue.mitigation.author [ Reference(Practitioner|PractitionerRole) ]; # 0..1 Who is committing? ], ...; ]
Changes
since
DSTU2
R3
| DetectedIssue | |
| DetectedIssue.identifier |
|
| DetectedIssue.status |
|
| DetectedIssue.code |
|
| DetectedIssue.severity |
|
| DetectedIssue.identified[x] |
|
| DetectedIssue.author |
|
| DetectedIssue.evidence |
|
| DetectedIssue.evidence.code |
|
| DetectedIssue.evidence.detail |
|
| DetectedIssue.mitigation.author |
|
| DetectedIssue.date |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See
R2
<-->
R3
<-->
R4
Conversion
Maps
(status
=
4
tests
that
all
execute
ok.
All
tests
pass
round-trip
testing
and
4
all
r3
resources
are
invalid
(4
errors).
).
valid.)
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
Clinical
issue
with
action
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
Unique
id
for
the
detected
issue
|
|
?! Σ | 1..1 | code |
registered
|
preliminary
|
final
|
amended
+
ObservationStatus ( Required ) |
|
Σ | 0..1 | CodeableConcept |
Issue
Category,
e.g.
drug-drug,
duplicate
therapy,
etc.
Detected Issue Category ( Preferred ) |
|
Σ | 0..1 | code |
high
|
moderate
|
low
DetectedIssueSeverity ( Required ) |
|
Σ | 0..1 | Reference ( Patient ) | Associated patient |
|
Σ | 0..1 | When identified | |
![]() ![]() ![]() | dateTime | |||
| Period | |||
|
Σ | 0..1 | Reference ( Practitioner | PractitionerRole | Device ) | The provider or device that identified the issue |
|
Σ | 0..* | Reference ( Any ) |
Problem
resource
|
| 0..* | BackboneElement |
Supporting
evidence
| |
![]() ![]() ![]() | 0..* | CodeableConcept |
Manifestation
Manifestation and Symptom Codes ( Example ) | |
![]() ![]() ![]() | 0..* | Reference ( Any ) |
Supporting
information
| |
|
0..1 | string | Description and context | |
|
0..1 | uri | Authority for issue | |
|
0..* | BackboneElement |
Step
taken
to
address
|
|
|
1..1 | CodeableConcept |
What
mitigation?
Detected Issue Mitigation Action ( Preferred ) |
|
|
0..1 | dateTime | Date committed | |
|
0..1 | Reference ( Practitioner | PractitionerRole ) | Who is committing? | |
Documentation
for
this
format
|
||||
XML Template
<<DetectedIssue xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier> < <</category> <<identifier><!-- 0..* Identifier Unique id for the detected issue --></identifier> <status value="[code]"/><!-- 1..1 registered | preliminary | final | amended + --> <code><!-- 0..1 CodeableConcept Issue Category, e.g. drug-drug, duplicate therapy, etc. --></code> <severity value="[code]"/><!-- 0..1 high | moderate | low --> <patient><!-- 0..1 Reference(Patient) Associated patient --></patient>< <</author><identified[x]><!-- 0..1 dateTime|Period When identified --></identified[x]> <author><!-- 0..1 Reference(Practitioner|PractitionerRole|Device) The provider or device that identified the issue --></author> <implicated><!-- 0..* Reference(Any) Problem resource --></implicated>< < <<evidence> <!-- 0..* Supporting evidence --> <code><!-- 0..* CodeableConcept Manifestation --></code> <detail><!-- 0..* Reference(Any) Supporting information --></detail> </evidence> <detail value="[string]"/><!-- 0..1 Description and context --> <reference value="[uri]"/><!-- 0..1 Authority for issue --> <mitigation> <!-- 0..* Step taken to address --> <action><!-- 1..1 CodeableConcept What mitigation? --></action>< <</author><date value="[dateTime]"/><!-- 0..1 Date committed --> <author><!-- 0..1 Reference(Practitioner|PractitionerRole) Who is committing? --></author> </mitigation> </DetectedIssue>
JSON Template
{
"resourceType" : "",
"resourceType" : "DetectedIssue",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"identifier" : [{ Identifier }], // Unique id for the detected issue
"status" : "<code>", // R! registered | preliminary | final | amended +
"code" : { CodeableConcept }, // Issue Category, e.g. drug-drug, duplicate therapy, etc.
"severity" : "<code>", // high | moderate | low
"patient" : { Reference(Patient) }, // Associated patient
// identified[x]: When identified. One of these 2:
"identifiedDateTime" : "<dateTime>",
"identifiedPeriod" : { Period },
"author" : { Reference(Practitioner|PractitionerRole|Device) }, // The provider or device that identified the issue
"implicated" : [{ Reference(Any) }], // Problem resource
"evidence" : [{ // Supporting evidence
"code" : [{ CodeableConcept }], // Manifestation
"detail" : [{ Reference(Any) }] // Supporting information
}],
"detail" : "<string>", // Description and context
"reference" : "<uri>", // Authority for issue
"mitigation" : [{ // Step taken to address
"action" : { CodeableConcept }, // R! What mitigation?
"date" : "<dateTime>", // Date committed
"author" : { Reference(Practitioner|PractitionerRole) } // Who is committing?
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:DetectedIssue; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension
fhir:fhir:DetectedIssue.identifier [ Identifier ], ... ; # 0..* Unique id for the detected issue fhir:DetectedIssue.status [ code ]; # 1..1 registered | preliminary | final | amended +fhir:fhir:DetectedIssue.code [ CodeableConcept ]; # 0..1 Issue Category, e.g. drug-drug, duplicate therapy, etc. fhir:DetectedIssue.severity [ code ]; # 0..1 high | moderate | low fhir:DetectedIssue.patient [ Reference(Patient) ]; # 0..1 Associated patientfhir: fhir:# DetectedIssue.identified[x] : 0..1 When identified. One of these 2 fhir:DetectedIssue.identifiedDateTime [ dateTime ] fhir:DetectedIssue.identifiedPeriod [ Period ] fhir:DetectedIssue.author [ Reference(Practitioner|PractitionerRole|Device) ]; # 0..1 The provider or device that identified the issue fhir:DetectedIssue.implicated [ Reference(Any) ], ... ; # 0..* Problem resource fhir:DetectedIssue.evidence [ # 0..* Supporting evidence fhir:DetectedIssue.evidence.code [ CodeableConcept ], ... ; # 0..* Manifestation fhir:DetectedIssue.evidence.detail [ Reference(Any) ], ... ; # 0..* Supporting information ], ...; fhir:DetectedIssue.detail [ string ]; # 0..1 Description and context fhir:DetectedIssue.reference [ uri ]; # 0..1 Authority for issuefhir:fhir:DetectedIssue.mitigation [ # 0..* Step taken to address fhir:DetectedIssue.mitigation.action [ CodeableConcept ]; # 1..1 What mitigation? fhir:DetectedIssue.mitigation.date [ dateTime ]; # 0..1 Date committedfhir:fhir:DetectedIssue.mitigation.author [ Reference(Practitioner|PractitionerRole) ]; # 0..1 Who is committing? ], ...; ]
Changes
since
DSTU2
Release
3
| DetectedIssue | |
| DetectedIssue.identifier |
|
| DetectedIssue.status |
|
| DetectedIssue.code |
|
| DetectedIssue.severity |
|
| DetectedIssue.identified[x] |
|
| DetectedIssue.author |
|
| DetectedIssue.evidence |
|
| DetectedIssue.evidence.code |
|
| DetectedIssue.evidence.detail |
|
| DetectedIssue.mitigation.author |
|
| DetectedIssue.date |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See
R2
<-->
R3
<-->
R4
Conversion
Maps
(status
=
4
tests
that
all
execute
ok.
All
tests
pass
round-trip
testing
and
4
all
r3
resources
are
invalid
(4
errors).
).
valid.)
Alternate
See
the
Profiles
&
Extensions
and
the
alternate
definitions:
Master
Definition
(
XML
,
+
JSON
),
,
XML
Schema
/
Schematron
(for
)
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
&
the
dependency
analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| DetectedIssue.status |
Indicates
the
status
of
the
identified
|
Required | ObservationStatus |
|
|
Codes identifying the general type of detected issue; e.g. Drug-drug interaction, Timing issue, Duplicate therapy, etc. | Preferred |
|
| DetectedIssue.severity | Indicates the potential degree of impact of the identified issue on the patient. | Required | DetectedIssueSeverity |
| DetectedIssue.evidence.code | Codes that describes the types of evidence for a detected issue. | Example | ManifestationAndSymptomCodes |
| DetectedIssue.mitigation.action | Codes describing steps taken to resolve the issue or other circumstances that mitigate the risk associated with the issue; e.g. 'added concurrent therapy', 'prior therapy documented', etc. | Preferred |
|
DetectedIssue
follows
the
pattern
of
linking
from
the
resource
created
"second".
"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"
"owned"
by
the
record
whose
creation
triggers
the
contraindication
being
created
-
i.e.
the
"second"
"second"
or
"last"
"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.
| Name | Type | Description | Expression | In Common |
| author | reference | The provider or device that identified the issue |
DetectedIssue.author
( Practitioner , Device , PractitionerRole ) |
|
|
|
token | Issue Category, e.g. drug-drug, duplicate therapy, etc. |
|
|
|
|
date | When identified |
|
|
| identifier | token | Unique id for the detected issue | DetectedIssue.identifier |
|
| implicated | reference | Problem resource |
DetectedIssue.implicated
(Any) |
|
| patient | reference | Associated patient |
DetectedIssue.patient
( Patient ) |
|