GuidanceResponse - FHIR Resource (r4)


This GuidanceResponse Resource uses the FHIR API standard for access and structure.

Validate an GuidanceResponse FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
dataRequirementtrueDataRequirement# Additional required data
encounterfalseReference# Encounter during which the response was returned
evaluationMessagetrueReference# Messages resulting from the evaluation of the artifact or artifacts
identifiertrueIdentifier# Business identifier
module[x]falseuri|canonical|CodeableConcept#undefined
notetrueAnnotation# Additional notes about the response
occurrenceDateTimefalsedateTime# When the guidance response was processed
outputParametersfalseReference# The output parameters of the evaluation, if any
performerfalseReference# Device returning the guidance
reasonCodetrueCodeableConcept# Why guidance is needed
reasonReferencetrueReference# "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
requestIdentifierfalseIdentifier# The identifier of the request associated with this response, if any
resultfalseReference# Proposed actions, if any
statusfalsecode# success | data-requested | data-required | in-progress | failure | entered-in-error
subjectfalseReference# Patient the request was performed for

GuidanceResponse Example

{
  "resourceType": "GuidanceResponse",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>contained</b>: </p><p><b>requestIdentifier</b>: guidanceRequest1</p><p><b>identifier</b>: guidanceResponse1</p><p><b>module</b>: <a>http://someguidelineprovider.org/radiology-appropriateness-guidelines.html</a></p><p><b>status</b>: success</p><p><b>subject</b>: <a>Patient/example</a></p><p><b>encounter</b>: <a>Encounter/example</a></p><p><b>occurrenceDateTime</b>: 10/03/2017 4:02:00 PM</p><p><b>performer</b>: <a>Device/software</a></p><p><b>reasonCode</b>: Guideline Appropriate Ordering Assessment <span>(Details )</span></p><p><b>outputParameters</b>: id: outputParameters1</p></div>"
  },
  "contained": [
    {
      "resourceType": "Parameters",
      "id": "outputParameters1",
      "parameter": [
        {
          "name": "score",
          "valueDecimal": 7
        },
        {
          "name": "item-assessed",
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "http://www.ama-assn.org/go/cpt",
                "code": "70450",
                "display": "CT, head, wo iv contrast"
              }
            ]
          }
        },
        {
          "name": "device",
          "valueReference": {
            "reference": "Device/software"
          }
        },
        {
          "name": "guideline-followed",
          "valueUri": "http://someguidelineprovider.org/radiology-appropriateness-guidelines.html"
        }
      ]
    }
  ],
  "requestIdentifier": {
    "system": "http://example.org",
    "value": "guidanceRequest1"
  },
  "identifier": [
    {
      "system": "http://example.org",
      "value": "guidanceResponse1"
    }
  ],
  "moduleUri": "http://someguidelineprovider.org/radiology-appropriateness-guidelines.html",
  "status": "success",
  "subject": {
    "reference": "Patient/example"
  },
  "encounter": {
    "reference": "Encounter/example"
  },
  "occurrenceDateTime": "2017-03-10T16:02:00Z",
  "performer": {
    "reference": "Device/software"
  },
  "reasonCode": [
    {
      "text": "Guideline Appropriate Ordering Assessment"
    }
  ],
  "outputParameters": {
    "reference": "#outputParameters1"
  }
}

GuidanceResponse Structure

{
  "resourceType" : "GuidanceResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "requestIdentifier" : { Identifier }, // The identifier of the request associated with this response, if any
  "identifier" : [{ Identifier }], // Business identifier
  // module[x]: What guidance was requested. One of these 3:
  "moduleUri" : "<uri>",
  "moduleCanonical" : "<canonical>",
  "moduleCodeableConcept" : { CodeableConcept },
  "status" : "<code>", // R!  success | data-requested | data-required | in-progress | failure | entered-in-error
  "subject" : { Reference(Patient|Group) }, // Patient the request was performed for
  "encounter" : { Reference(Encounter) }, // Encounter during which the response was returned
  "occurrenceDateTime" : "<dateTime>", // When the guidance response was processed
  "performer" : { Reference(Device) }, // Device returning the guidance
  "reasonCode" : [{ CodeableConcept }], // Why guidance is needed
  "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
   DocumentReference) }], // Why guidance is needed
  "note" : [{ Annotation }], // Additional notes about the response
  "evaluationMessage" : [{ Reference(OperationOutcome) }], // Messages resulting from the evaluation of the artifact or artifacts
  "outputParameters" : { Reference(Parameters) }, // The output parameters of the evaluation, if any
  "result" : { Reference(CarePlan|RequestGroup) }, // Proposed actions, if any
  "dataRequirement" : [{ DataRequirement }] // Additional required data
}

GuidanceResponse Search Parameters

The following search parameters can be used to query GuidanceResponse resources. Just submit them like so:

https://api.1up.health/fhir/r4/GuidanceResponse?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
identifiertextidentifier
patientreferencesubject.where
requesttextrequestIdentifier
subjectreferencesubject