# GuidanceResponse

Canonical page: https://docs.ovok.com/api/fhir/r4/guidance-response

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.

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/GuidanceResponse/[id]` |
| Vread | `GET` | `/fhir/R4/GuidanceResponse/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/GuidanceResponse/[id]` |
| Patch | `PATCH` | `/fhir/R4/GuidanceResponse/[id]` |
| Delete | `DELETE` | `/fhir/R4/GuidanceResponse/[id]` |
| Create | `POST` | `/fhir/R4/GuidanceResponse` |
| Search | `GET` | `/fhir/R4/GuidanceResponse` |
| History | `GET` | `/fhir/R4/GuidanceResponse/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-request-identifier"></span>`requestIdentifier` | [Identifier](/fhir-elements/complex/identifier) | `0..1` | The identifier of the request associated with this response, if any |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Business identifier |
| <span id="element-module-x"></span>`module[x]` | [uri](/fhir-elements/primitive/uri), [canonical](/fhir-elements/primitive/canonical), [CodeableConcept](/fhir-elements/complex/codeable-concept) | `1..1` | What guidance was requested |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | success \| data-requested \| data-required \| in-progress \| failure \| entered-in-error |
| <span id="element-subject"></span>`subject` | [Reference](/fhir-elements/complex/reference) | `0..1` | Patient the request was performed for |
| <span id="element-encounter"></span>`encounter` | [Reference](/fhir-elements/complex/reference) | `0..1` | Encounter during which the response was returned |
| <span id="element-occurrence-date-time"></span>`occurrenceDateTime` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | When the guidance response was processed |
| <span id="element-performer"></span>`performer` | [Reference](/fhir-elements/complex/reference) | `0..1` | Device returning the guidance |
| <span id="element-reason-code"></span>`reasonCode` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Why guidance is needed |
| <span id="element-reason-reference"></span>`reasonReference` | [Reference](/fhir-elements/complex/reference) | `0..*` | Why guidance is needed |
| <span id="element-note"></span>`note` | [Annotation](/fhir-elements/complex/annotation) | `0..*` | Additional notes about the response |
| <span id="element-evaluation-message"></span>`evaluationMessage` | [Reference](/fhir-elements/complex/reference) | `0..*` | Messages resulting from the evaluation of the artifact or artifacts |
| <span id="element-output-parameters"></span>`outputParameters` | [Reference](/fhir-elements/complex/reference) | `0..1` | The output parameters of the evaluation, if any |
| <span id="element-result"></span>`result` | [Reference](/fhir-elements/complex/reference) | `0..1` | Proposed actions, if any |
| <span id="element-data-requirement"></span>`dataRequirement` | [DataRequirement](/fhir-elements/complex/data-requirement) | `0..*` | Additional required data |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `identifier` | token | The identifier of the guidance response |
| `patient` | reference | The identity of a patient to search for guidance response results |
| `request` | token | The identifier of the request associated with the response |
| `subject` | reference | The subject that the guidance response is about |

## Reference [#reference]

Official FHIR R4 spec: [GuidanceResponse](https://hl7.org/fhir/R4/guidanceresponse.html).  
Maturity: Trial Use 2 (FMM 2).
