eHealth Infrastructure
3.0.0 - release

eHealth Infrastructure - Local Development build (v3.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ehealth-guidanceresponse

Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guidanceresponse Version: 3.0.0
Active as of 2024-05-16 Computable Name: ehealth-guidanceresponse

Introduction

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.

Scope and Usage

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:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from GuidanceResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse 0..*GuidanceResponseThe formal response to a guidance request
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... episodeOfCare 1..1Reference(ehealth-episodeofcare)Episode of care
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guidanceresponse-episodeOfCare
... subject 0..1Reference(ehealth-patient) {r}Patient the request was performed for
... evaluationMessage 0..*Reference(OperationOutcome) {r}Messages resulting from the evaluation of the artifact or artifacts
... result 0..1Reference(ehealth-careplan | RequestGroup) {r}Proposed actions, if any

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse 0..*GuidanceResponseThe formal response to a guidance request
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... episodeOfCare 1..1Reference(ehealth-episodeofcare)Episode of care
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guidanceresponse-episodeOfCare
... module[x] Σ1..1What guidance was requested
.... moduleUriuri
.... moduleCanonicalcanonical(Any)
.... moduleCodeableConceptCodeableConcept
... status ?!Σ1..1codesuccess | data-requested | data-required | in-progress | failure | entered-in-error
Binding: GuidanceResponseStatus (required): The status of a guidance response.

... subject 0..1Reference(ehealth-patient) {r}Patient the request was performed for
... performer 0..1Reference(ehealth-device) {r}Device returning the guidance
... evaluationMessage 0..*Reference(OperationOutcome) {r}Messages resulting from the evaluation of the artifact or artifacts
... result 0..1Reference(ehealth-careplan | RequestGroup) {r}Proposed actions, if any

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
GuidanceResponse.statusrequiredGuidanceResponseStatus
http://hl7.org/fhir/ValueSet/guidance-response-status|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse 0..*GuidanceResponseThe formal response to a guidance request
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... episodeOfCare 1..1Reference(ehealth-episodeofcare)Episode of care
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guidanceresponse-episodeOfCare
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... requestIdentifier Σ0..1IdentifierThe identifier of the request associated with this response, if any
... identifier Σ0..*IdentifierBusiness identifier
... module[x] Σ1..1What guidance was requested
.... moduleUriuri
.... moduleCanonicalcanonical(Any)
.... moduleCodeableConceptCodeableConcept
... status ?!Σ1..1codesuccess | data-requested | data-required | in-progress | failure | entered-in-error
Binding: GuidanceResponseStatus (required): The status of a guidance response.

... subject 0..1Reference(ehealth-patient) {r}Patient the request was performed for
... encounter 0..1Reference(Encounter)Encounter during which the response was returned
... occurrenceDateTime 0..1dateTimeWhen the guidance response was processed
... performer 0..1Reference(ehealth-device) {r}Device returning the guidance
... reasonCode 0..*CodeableConceptWhy guidance is needed
... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why guidance is needed
... note 0..*AnnotationAdditional notes about the response
... evaluationMessage 0..*Reference(OperationOutcome) {r}Messages resulting from the evaluation of the artifact or artifacts
... outputParameters 0..1Reference(Parameters)The output parameters of the evaluation, if any
... result 0..1Reference(ehealth-careplan | RequestGroup) {r}Proposed actions, if any
... dataRequirement 0..*DataRequirementAdditional required data

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
GuidanceResponse.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
GuidanceResponse.statusrequiredGuidanceResponseStatus
http://hl7.org/fhir/ValueSet/guidance-response-status|4.0.1
from the FHIR Standard

Differential View

This structure is derived from GuidanceResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse 0..*GuidanceResponseThe formal response to a guidance request
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... episodeOfCare 1..1Reference(ehealth-episodeofcare)Episode of care
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guidanceresponse-episodeOfCare
... subject 0..1Reference(ehealth-patient) {r}Patient the request was performed for
... evaluationMessage 0..*Reference(OperationOutcome) {r}Messages resulting from the evaluation of the artifact or artifacts
... result 0..1Reference(ehealth-careplan | RequestGroup) {r}Proposed actions, if any

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse 0..*GuidanceResponseThe formal response to a guidance request
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... episodeOfCare 1..1Reference(ehealth-episodeofcare)Episode of care
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guidanceresponse-episodeOfCare
... module[x] Σ1..1What guidance was requested
.... moduleUriuri
.... moduleCanonicalcanonical(Any)
.... moduleCodeableConceptCodeableConcept
... status ?!Σ1..1codesuccess | data-requested | data-required | in-progress | failure | entered-in-error
Binding: GuidanceResponseStatus (required): The status of a guidance response.

... subject 0..1Reference(ehealth-patient) {r}Patient the request was performed for
... performer 0..1Reference(ehealth-device) {r}Device returning the guidance
... evaluationMessage 0..*Reference(OperationOutcome) {r}Messages resulting from the evaluation of the artifact or artifacts
... result 0..1Reference(ehealth-careplan | RequestGroup) {r}Proposed actions, if any

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
GuidanceResponse.statusrequiredGuidanceResponseStatus
http://hl7.org/fhir/ValueSet/guidance-response-status|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse 0..*GuidanceResponseThe formal response to a guidance request
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... episodeOfCare 1..1Reference(ehealth-episodeofcare)Episode of care
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-guidanceresponse-episodeOfCare
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... requestIdentifier Σ0..1IdentifierThe identifier of the request associated with this response, if any
... identifier Σ0..*IdentifierBusiness identifier
... module[x] Σ1..1What guidance was requested
.... moduleUriuri
.... moduleCanonicalcanonical(Any)
.... moduleCodeableConceptCodeableConcept
... status ?!Σ1..1codesuccess | data-requested | data-required | in-progress | failure | entered-in-error
Binding: GuidanceResponseStatus (required): The status of a guidance response.

... subject 0..1Reference(ehealth-patient) {r}Patient the request was performed for
... encounter 0..1Reference(Encounter)Encounter during which the response was returned
... occurrenceDateTime 0..1dateTimeWhen the guidance response was processed
... performer 0..1Reference(ehealth-device) {r}Device returning the guidance
... reasonCode 0..*CodeableConceptWhy guidance is needed
... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why guidance is needed
... note 0..*AnnotationAdditional notes about the response
... evaluationMessage 0..*Reference(OperationOutcome) {r}Messages resulting from the evaluation of the artifact or artifacts
... outputParameters 0..1Reference(Parameters)The output parameters of the evaluation, if any
... result 0..1Reference(ehealth-careplan | RequestGroup) {r}Proposed actions, if any
... dataRequirement 0..*DataRequirementAdditional required data

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
GuidanceResponse.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
GuidanceResponse.statusrequiredGuidanceResponseStatus
http://hl7.org/fhir/ValueSet/guidance-response-status|4.0.1
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron