eHealth Infrastructure (v2020.8)

StructureDefinition: 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.

Formal Views of Profile Content

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 Thu Jan 07 13:26:31 UTC 2021 as a draft by null.

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

This structure is derived from GuidanceResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse 0..*GuidanceResponseThe formal response to a guidance request
... module 1..1Reference(ServiceDefinition) {rc}A reference to a knowledge module
... subject 0..1Reference(eHealth Patient) {r}Patient the request was performed for
... context 0..1Reference(Encounter | eHealth EpisodeOfCare) {r}Encounter or Episode during which the response was returned
... performer 0..1Reference(eHealth Device) {r}Device returning the guidance
... reason[x] 0..1Reason for the response
.... reasonCodeableConceptCodeableConcept
.... reasonReferenceReference(Resource)
... 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

This structure is derived from GuidanceResponse

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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... requestId Σ0..1idThe id of the request associated with this response, if any
... identifier Σ0..1IdentifierBusiness identifier
... module Σ1..1Reference(ServiceDefinition) {rc}A reference to a knowledge module
... 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
... context 0..1Reference(Encounter | eHealth EpisodeOfCare) {r}Encounter or Episode during which the response was returned
... occurrenceDateTime 0..1dateTimeWhen the guidance response was processed
... performer 0..1Reference(eHealth Device) {r}Device returning the guidance
... reason[x] 0..1Reason for the response
.... reasonCodeableConceptCodeableConcept
.... reasonReferenceReference(Resource)
... 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

Differential View

This structure is derived from GuidanceResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse 0..*GuidanceResponseThe formal response to a guidance request
... module 1..1Reference(ServiceDefinition) {rc}A reference to a knowledge module
... subject 0..1Reference(eHealth Patient) {r}Patient the request was performed for
... context 0..1Reference(Encounter | eHealth EpisodeOfCare) {r}Encounter or Episode during which the response was returned
... performer 0..1Reference(eHealth Device) {r}Device returning the guidance
... reason[x] 0..1Reason for the response
.... reasonCodeableConceptCodeableConcept
.... reasonReferenceReference(Resource)
... 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

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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... requestId Σ0..1idThe id of the request associated with this response, if any
... identifier Σ0..1IdentifierBusiness identifier
... module Σ1..1Reference(ServiceDefinition) {rc}A reference to a knowledge module
... 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
... context 0..1Reference(Encounter | eHealth EpisodeOfCare) {r}Encounter or Episode during which the response was returned
... occurrenceDateTime 0..1dateTimeWhen the guidance response was processed
... performer 0..1Reference(eHealth Device) {r}Device returning the guidance
... reason[x] 0..1Reason for the response
.... reasonCodeableConceptCodeableConcept
.... reasonReferenceReference(Resource)
... 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

PathConformanceValueSet
GuidanceResponse.languageextensibleCommon Languages
Max Binding: All Languages
GuidanceResponse.statusrequiredGuidanceResponseStatus

Constraints

IdPathDetailsRequirements
dom-2GuidanceResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1GuidanceResponseIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4GuidanceResponseIf 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-3GuidanceResponseIf 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()
.