Skip to main content

GuidanceResponse

PropertyValue
Publisher
NameGuidanceResponse
URLhttp://hl7.org/fhir/StructureDefinition/GuidanceResponse
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
GuidanceResponse0..*GuidanceResponseA 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.
GuidanceResponse.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
GuidanceResponse.meta0..1MetaThe 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.
GuidanceResponse.implicitRules0..1uriA 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.
GuidanceResponse.language0..1codeThe base language in which the resource is written.
GuidanceResponse.text0..1NarrativeA 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.
GuidanceResponse.contained0..*ResourceThese 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.
GuidanceResponse.extension0..*ExtensionMay 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.
GuidanceResponse.modifierExtension0..*ExtensionMay 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).
GuidanceResponse.requestIdentifier0..1IdentifierThe 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.
GuidanceResponse.identifier0..*IdentifierAllows a service to provide unique, business identifiers for the response.
GuidanceResponse.module[x]1..1uriAn identifier, CodeableConcept or canonical reference to the guidance that was requested.
GuidanceResponse.status1..1codeThe 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.
GuidanceResponse.subject0..1ReferenceThe patient for which the request was processed.
GuidanceResponse.encounter0..1ReferenceThe encounter during which this response was created or to which the creation of this record is tightly associated.
GuidanceResponse.occurrenceDateTime0..1dateTimeIndicates when the guidance response was processed.
GuidanceResponse.performer0..1ReferenceProvides a reference to the device that performed the guidance.
GuidanceResponse.reasonCode0..*CodeableConceptDescribes the reason for the guidance response in coded or textual form.
GuidanceResponse.reasonReference0..*ReferenceIndicates 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.
GuidanceResponse.note0..*AnnotationProvides a mechanism to communicate additional information about the response.
GuidanceResponse.evaluationMessage0..*ReferenceMessages 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.
GuidanceResponse.outputParameters0..1ReferenceThe 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.
GuidanceResponse.result0..1ReferenceThe actions, if any, produced by the evaluation of the artifact.
GuidanceResponse.dataRequirement0..*DataRequirementIf 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 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

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
identifiertokenThe identifier of the guidance responseGuidanceResponse.identifier
patientreferenceThe identity of a patient to search for guidance response resultsGuidanceResponse.subject.where(resolve() is Patient)
requesttokenThe identifier of the request associated with the responseGuidanceResponse.requestIdentifier
subjectreferenceThe subject that the guidance response is aboutGuidanceResponse.subject