The GuidanceResponse resource is used to represent the result of invoking a decision support service. It provides a container for the status of the response, any warnings or messages returned by the service, as well as the output data of the module and any suggested actions to be performed.
In the eHealth Infrastructure, a GuidanceResponse is returned when invoking the operation evaluate
on
a Library instance. This could be performed as part of decision support usage or for determining
qualities such as the situation quality for a measurement based on answer(s) in a QuestionnaireResponse.
In the description of Library.evaluate
there is an example of input and output where GuidanceResponse
use is reflected.
A GuidanceResponse contains a mandatory element module
which references a knowledge module through a
ServiceDefinition resource.
In the eHealth Infrastructure, knowledge modules are represented as Library instances and the ServiceDefinition
is not used in the eHealth Infrastructure. As it is not otherwise used, ServiceDefinition is left un-profiled
and referenced as a contained resource in GuidanceResponse.
When returned from the eHealth Infrastructure, the GuidanceResponse module
is a reference to a contained
ServiceDefinition containing minimal content. The ServiceDefinition element relatedArtifact
is set to reference
the Library.
The official URL for this profile is:
http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guidanceresponse
This profile builds on GuidanceResponse.
This profile was published on Fri May 22 12:11:22 UTC 2020 as a draft by null.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from GuidanceResponse
This structure is derived from GuidanceResponse
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
GuidanceResponse | 0..* | GuidanceResponse | The formal response to a guidance request | |
module | 1..1 | Reference(ServiceDefinition) {rc} | A reference to a knowledge module | |
subject | 0..1 | Reference(eHealth Patient) {r} | Patient the request was performed for | |
context | 0..1 | Reference(Encounter | eHealth EpisodeOfCare) {r} | Encounter or Episode during which the response was returned | |
performer | 0..1 | Reference(eHealth Device) {r} | Device returning the guidance | |
reason[x] | 0..1 | Reason for the response | ||
reasonCodeableConcept | CodeableConcept | |||
reasonReference | Reference(Resource) | |||
evaluationMessage | 0..* | Reference(OperationOutcome) {r} | Messages resulting from the evaluation of the artifact or artifacts | |
result | 0..1 | Reference(eHealth CarePlan | RequestGroup) {r} | Proposed actions, if any | |
Documentation for this format |
This structure is derived from GuidanceResponse
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
GuidanceResponse | I | 0..* | GuidanceResponse | The formal response to a guidance request |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
requestId | Σ | 0..1 | id | The id of the request associated with this response, if any |
identifier | Σ | 0..1 | Identifier | Business identifier |
module | Σ | 1..1 | Reference(ServiceDefinition) {rc} | A reference to a knowledge module |
status | ?!Σ | 1..1 | code | success | data-requested | data-required | in-progress | failure | entered-in-error Binding: GuidanceResponseStatus (required) |
subject | 0..1 | Reference(eHealth Patient) {r} | Patient the request was performed for | |
context | 0..1 | Reference(Encounter | eHealth EpisodeOfCare) {r} | Encounter or Episode during which the response was returned | |
occurrenceDateTime | 0..1 | dateTime | When the guidance response was processed | |
performer | 0..1 | Reference(eHealth Device) {r} | Device returning the guidance | |
reason[x] | 0..1 | Reason for the response | ||
reasonCodeableConcept | CodeableConcept | |||
reasonReference | Reference(Resource) | |||
note | 0..* | Annotation | Additional notes about the response | |
evaluationMessage | 0..* | Reference(OperationOutcome) {r} | Messages resulting from the evaluation of the artifact or artifacts | |
outputParameters | 0..1 | Reference(Parameters) | The output parameters of the evaluation, if any | |
result | 0..1 | Reference(eHealth CarePlan | RequestGroup) {r} | Proposed actions, if any | |
dataRequirement | 0..* | DataRequirement | Additional required data | |
Documentation for this format |
This structure is derived from GuidanceResponse
Differential View
This structure is derived from GuidanceResponse
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
GuidanceResponse | 0..* | GuidanceResponse | The formal response to a guidance request | |
module | 1..1 | Reference(ServiceDefinition) {rc} | A reference to a knowledge module | |
subject | 0..1 | Reference(eHealth Patient) {r} | Patient the request was performed for | |
context | 0..1 | Reference(Encounter | eHealth EpisodeOfCare) {r} | Encounter or Episode during which the response was returned | |
performer | 0..1 | Reference(eHealth Device) {r} | Device returning the guidance | |
reason[x] | 0..1 | Reason for the response | ||
reasonCodeableConcept | CodeableConcept | |||
reasonReference | Reference(Resource) | |||
evaluationMessage | 0..* | Reference(OperationOutcome) {r} | Messages resulting from the evaluation of the artifact or artifacts | |
result | 0..1 | Reference(eHealth CarePlan | RequestGroup) {r} | Proposed actions, if any | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
GuidanceResponse | I | 0..* | GuidanceResponse | The formal response to a guidance request |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
requestId | Σ | 0..1 | id | The id of the request associated with this response, if any |
identifier | Σ | 0..1 | Identifier | Business identifier |
module | Σ | 1..1 | Reference(ServiceDefinition) {rc} | A reference to a knowledge module |
status | ?!Σ | 1..1 | code | success | data-requested | data-required | in-progress | failure | entered-in-error Binding: GuidanceResponseStatus (required) |
subject | 0..1 | Reference(eHealth Patient) {r} | Patient the request was performed for | |
context | 0..1 | Reference(Encounter | eHealth EpisodeOfCare) {r} | Encounter or Episode during which the response was returned | |
occurrenceDateTime | 0..1 | dateTime | When the guidance response was processed | |
performer | 0..1 | Reference(eHealth Device) {r} | Device returning the guidance | |
reason[x] | 0..1 | Reason for the response | ||
reasonCodeableConcept | CodeableConcept | |||
reasonReference | Reference(Resource) | |||
note | 0..* | Annotation | Additional notes about the response | |
evaluationMessage | 0..* | Reference(OperationOutcome) {r} | Messages resulting from the evaluation of the artifact or artifacts | |
outputParameters | 0..1 | Reference(Parameters) | The output parameters of the evaluation, if any | |
result | 0..1 | Reference(eHealth CarePlan | RequestGroup) {r} | Proposed actions, if any | |
dataRequirement | 0..* | DataRequirement | Additional required data | |
Documentation for this format |
Path | Conformance | ValueSet |
GuidanceResponse.language | extensible | Common Languages Max Binding: All Languages |
GuidanceResponse.status | required | GuidanceResponseStatus |
Id | Path | Details | Requirements |
dom-2 | GuidanceResponse | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | GuidanceResponse | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | GuidanceResponse | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-3 | GuidanceResponse | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() |