This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
Responsible
Owner:
Clinical
Decision
Support
Work
Group
|
|
Security Category : Patient |
Compartments
:
|
Detailed Descriptions for the elements in the GuidanceResponse resource.
| GuidanceResponse | |
| Element Id | GuidanceResponse |
| Definition |
A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken. |
| Short Display | The formal response to a guidance request |
| Cardinality | 0..* |
| Type | DomainResource |
| Requirements |
The GuidanceResponse resource supports recording the results of decision support interactions, reportability determination for public health, as well as the communication of additional data requirements for subsequent interactions. |
| Summary | false |
| GuidanceResponse.requestIdentifier | |
| Element Id | GuidanceResponse.requestIdentifier |
| Definition |
The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario. |
| Short Display | The identifier of the request associated with this response, if any |
| Cardinality | 0..1 |
| Type | Identifier |
| Summary | true |
| GuidanceResponse.identifier | |
| Element Id | GuidanceResponse.identifier |
| Definition |
|
|
| Business identifier for guidance response |
| Note | This is a business identifier, not a resource identifier (see discussion ) |
| Cardinality | 0..* |
| Type | Identifier |
| Requirements | Allows identification of the guidance response as it is known by various participating systems and in a way that remains consistent across servers. |
| Summary | true |
| Comments | Note: This is a business identifier, not a resource identifier (see discussion ). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. |
| GuidanceResponse.module[x] | |
| Element Id | GuidanceResponse.module[x] |
| Definition |
An identifier, CodeableConcept or canonical reference to the guidance that was requested. |
| Short Display | What guidance was requested |
| Cardinality | 1..1 |
| Terminology Binding | Guidance Module Code ( Example ) |
| Type | uri | canonical | CodeableConcept |
| [x] Note |
See
Choice
of
|
| Summary | true |
| GuidanceResponse.status | |
| Element Id | GuidanceResponse.status |
| Definition |
The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information. |
| Short Display | success | data-requested | data-required | in-progress | failure | entered-in-error |
| Cardinality | 1..1 |
| Terminology Binding |
|
| Type | code |
| Is Modifier | true (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid) |
| Summary | true |
| Comments |
This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
| GuidanceResponse.subject | |
| Element Id | GuidanceResponse.subject |
| Definition |
The
|
| Short Display | Individual service was done for/to |
| Cardinality | 0..1 |
| Type | Reference ( Patient | Group ) |
| Requirements | Links the guidance response to the Patient context. May also affect access control. |
| Summary | true |
| GuidanceResponse.encounter | |
| Element Id | GuidanceResponse.encounter |
| Definition |
The
|
| Short Display | Encounter the guidance response is part of |
| Cardinality | 0..1 |
| Type | Reference ( Encounter ) |
|
| Links the guidance response to the Encounter context. May also affect access control. |
| Summary | true |
| Comments |
This
will
typically
be
the
encounter
the
|
| GuidanceResponse.occurrenceDateTime | |
| Element Id | GuidanceResponse.occurrenceDateTime |
| Definition |
Indicates when the guidance response was processed. |
| Short Display | When the guidance response was processed |
| Cardinality | 0..1 |
| Type | dateTime |
| Summary | true |
| GuidanceResponse.performer | |
| Element Id | GuidanceResponse.performer |
| Definition |
Provides a reference to the device that performed the guidance. |
| Short Display | Device returning the guidance |
| Cardinality | 0..1 |
| Type | Reference ( Device ) |
| Summary | false |
|
|
|
| Element Id |
|
| Definition |
|
| Short Display | Where guidance response occurred |
| Cardinality |
|
| Type | Reference ( Location ) |
| Requirements | Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting). |
|
|
true |
|
|
|
| Element Id |
|
| Definition |
Describes the reason for the guidance response in coded or textual form, or Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response. |
| Short Display | Why guidance is needed |
| Cardinality | 0..* |
| Type |
|
|
Summary
|
true |
| Comments |
Although
this
reference
can
be
used
to
point
to
any
resource,
it
is
typically
expected
to
refer
to
subject-specific
data
appropriate
to
the
subject
of
the
guidance.
For
example,
patient-based
decision
support
would
be
expected
to
reference
patient-level
data.
In
addition,
implementations
should
provide
as
much
detail
as
possible
by
using
the
http://hl7.org/fhir/StructureDefinition/targetElement
|
| GuidanceResponse.note | |
| Element Id | GuidanceResponse.note |
| Definition |
Provides a mechanism to communicate additional information about the response. |
| Short Display | Additional notes about the response |
| Cardinality | 0..* |
| Type | Annotation |
| Summary | false |
| GuidanceResponse.evaluationMessage | |
| Element Id | GuidanceResponse.evaluationMessage |
| Definition |
Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element. |
| Short Display | Messages resulting from the evaluation of the artifact or artifacts |
| Cardinality |
|
| Type | Reference ( OperationOutcome ) |
| Summary | false |
| GuidanceResponse.outputParameters | |
| Element Id | GuidanceResponse.outputParameters |
| Definition |
The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element. |
| Short Display | The output parameters of the evaluation, if any |
| Cardinality | 0..1 |
| Type | Reference ( Parameters ) |
| Summary | false |
| GuidanceResponse.result | |
| Element Id | GuidanceResponse.result |
| Definition |
The actions, if any, produced by the evaluation of the artifact. |
| Short Display | Proposed actions, if any |
| Cardinality |
|
| Type |
Reference
(
Appointment
|
AppointmentResponse
|
CarePlan
|
|
| Summary | false |
| GuidanceResponse.dataRequirement | |
| Element Id | GuidanceResponse.dataRequirement |
| Definition |
If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data. |
| Short Display | Additional required data |
| Cardinality | 0..* |
| Type | DataRequirement |
| Summary | false |