eHealth Infrastructure - Local Development build (vlatest) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guidanceresponse | Version: latest | |||
Active as of 2024-06-07 | Computable Name: ehealth-guidanceresponse |
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from GuidanceResponse
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
GuidanceResponse | 0..* | GuidanceResponse | The formal response to a guidance request | |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
episodeOfCare | 1..1 | Reference(ehealth-episodeofcare) | Episode of care URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guidanceresponse-episodeOfCare | |
subject | 0..1 | Reference(ehealth-patient) {r} | Patient the request was performed for | |
performer | 0..1 | Reference(ehealth-device) {r} | Device returning the guidance | |
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 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
GuidanceResponse | 0..* | GuidanceResponse | The formal response to a guidance request | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
episodeOfCare | 1..1 | Reference(ehealth-episodeofcare) | Episode of care URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guidanceresponse-episodeOfCare | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
module[x] | Σ | 1..1 | What guidance was requested | |
moduleUri | uri | |||
moduleCanonical | canonical(Any) | |||
moduleCodeableConcept | CodeableConcept | |||
status | ?!Σ | 1..1 | code | success | data-requested | data-required | in-progress | failure | entered-in-error Binding: GuidanceResponseStatus (required): The status of a guidance response. |
subject | 0..1 | Reference(ehealth-patient) {r} | Patient the request was performed for | |
performer | 0..1 | Reference(ehealth-device) {r} | Device returning the guidance | |
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 |
Path | Conformance | ValueSet | URI |
GuidanceResponse.status | required | GuidanceResponseStatushttp://hl7.org/fhir/ValueSet/guidance-response-status|4.0.1 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
GuidanceResponse | 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: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
episodeOfCare | 1..1 | Reference(ehealth-episodeofcare) | Episode of care URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guidanceresponse-episodeOfCare | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
requestIdentifier | Σ | 0..1 | Identifier | The identifier of the request associated with this response, if any | ||||
identifier | Σ | 0..* | Identifier | Business identifier | ||||
module[x] | Σ | 1..1 | What guidance was requested | |||||
moduleUri | uri | |||||||
moduleCanonical | canonical(Any) | |||||||
moduleCodeableConcept | CodeableConcept | |||||||
status | ?!Σ | 1..1 | code | success | data-requested | data-required | in-progress | failure | entered-in-error Binding: GuidanceResponseStatus (required): The status of a guidance response. | ||||
subject | 0..1 | Reference(ehealth-patient) {r} | Patient the request was performed for | |||||
encounter | 0..1 | Reference(Encounter) | Encounter 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 | |||||
reasonCode | 0..* | CodeableConcept | Why guidance is needed | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why guidance is needed | |||||
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 | URI | |||
GuidanceResponse.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
GuidanceResponse.status | required | GuidanceResponseStatushttp://hl7.org/fhir/ValueSet/guidance-response-status|4.0.1 from the FHIR Standard |
This structure is derived from GuidanceResponse
Summary
Mandatory: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from GuidanceResponse
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
GuidanceResponse | 0..* | GuidanceResponse | The formal response to a guidance request | |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
episodeOfCare | 1..1 | Reference(ehealth-episodeofcare) | Episode of care URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guidanceresponse-episodeOfCare | |
subject | 0..1 | Reference(ehealth-patient) {r} | Patient the request was performed for | |
performer | 0..1 | Reference(ehealth-device) {r} | Device returning the guidance | |
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 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
GuidanceResponse | 0..* | GuidanceResponse | The formal response to a guidance request | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
episodeOfCare | 1..1 | Reference(ehealth-episodeofcare) | Episode of care URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guidanceresponse-episodeOfCare | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
module[x] | Σ | 1..1 | What guidance was requested | |
moduleUri | uri | |||
moduleCanonical | canonical(Any) | |||
moduleCodeableConcept | CodeableConcept | |||
status | ?!Σ | 1..1 | code | success | data-requested | data-required | in-progress | failure | entered-in-error Binding: GuidanceResponseStatus (required): The status of a guidance response. |
subject | 0..1 | Reference(ehealth-patient) {r} | Patient the request was performed for | |
performer | 0..1 | Reference(ehealth-device) {r} | Device returning the guidance | |
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 |
Path | Conformance | ValueSet | URI |
GuidanceResponse.status | required | GuidanceResponseStatushttp://hl7.org/fhir/ValueSet/guidance-response-status|4.0.1 from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
GuidanceResponse | 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: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
episodeOfCare | 1..1 | Reference(ehealth-episodeofcare) | Episode of care URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guidanceresponse-episodeOfCare | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
requestIdentifier | Σ | 0..1 | Identifier | The identifier of the request associated with this response, if any | ||||
identifier | Σ | 0..* | Identifier | Business identifier | ||||
module[x] | Σ | 1..1 | What guidance was requested | |||||
moduleUri | uri | |||||||
moduleCanonical | canonical(Any) | |||||||
moduleCodeableConcept | CodeableConcept | |||||||
status | ?!Σ | 1..1 | code | success | data-requested | data-required | in-progress | failure | entered-in-error Binding: GuidanceResponseStatus (required): The status of a guidance response. | ||||
subject | 0..1 | Reference(ehealth-patient) {r} | Patient the request was performed for | |||||
encounter | 0..1 | Reference(Encounter) | Encounter 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 | |||||
reasonCode | 0..* | CodeableConcept | Why guidance is needed | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why guidance is needed | |||||
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 | URI | |||
GuidanceResponse.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
GuidanceResponse.status | required | GuidanceResponseStatushttp://hl7.org/fhir/ValueSet/guidance-response-status|4.0.1 from the FHIR Standard |
This structure is derived from GuidanceResponse
Summary
Mandatory: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron