GuidanceResponse | Medplum

On this page

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.

Elements

Name	Required	Type	Description
requestIdentifier		Identifier	The identifier of the request associated with this response, if any Details 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.
identifier		Identifier[]	Business identifier Details Allows a service to provide unique, business identifiers for the response.
module[x]	✓	uri, canonical, CodeableConcept	What guidance was requested Details An identifier, CodeableConcept or canonical reference to the guidance that was requested.
status	✓	code	success \| data-requested \| data-required \| in-progress \| failure \| entered-in-error Details 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. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
subject		Reference< Patient \| Group >	Patient the request was performed for Details The patient for which the request was processed.
encounter		Reference< Encounter >	Encounter during which the response was returned Details The encounter during which this response was created or to which the creation of this record is tightly associated. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.
occurrenceDateTime		dateTime	When the guidance response was processed Details Indicates when the guidance response was processed.
performer		Reference< Device >	Device returning the guidance Details Provides a reference to the device that performed the guidance.
reasonCode		CodeableConcept[]	Why guidance is needed Details Describes the reason for the guidance response in coded or textual form.
reasonReference		Reference< Condition \| Observation \| DiagnosticReport \| DocumentReference >[]	Why guidance is needed Details 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.
note		Annotation[]	Additional notes about the response Details Provides a mechanism to communicate additional information about the response.
evaluationMessage		Reference< OperationOutcome >[]	Messages resulting from the evaluation of the artifact or artifacts Details 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.
outputParameters		Reference< Parameters >	The output parameters of the evaluation, if any Details 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.
result		Reference< CarePlan \| RequestGroup >	Proposed actions, if any Details The actions, if any, produced by the evaluation of the artifact.
dataRequirement		DataRequirement[]	Additional required data Details 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 provide a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.

Search Parameters

Name	Type	Description	Expression
identifier	token	The identifier of the guidance response	GuidanceResponse.identifier
patient	reference	The identity of a patient to search for guidance response results	GuidanceResponse.subject.where((resolve() is Patient))
request	token	The identifier of the request associated with the response	GuidanceResponse.requestIdentifier
subject	reference	The subject that the guidance response is about	GuidanceResponse.subject

Inherited Elements

Name	Required	Type	Description
id		string	Logical id of this artifact Details The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
meta		Meta	Metadata about the resource Details The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules		uri	A set of rules under which this content was created Details A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.
language		code	Language of the resource content Details The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
text		Narrative	Text summary of the resource, for human interpretation Details A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
contained		Resource[]	Contained, inline Resources Details These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
extension		Extension[]	Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
modifierExtension		Extension[]	Extensions that cannot be ignored Details May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.