GuidanceResponse - FHIR Resource (stu3)


Resource Attributes

AttributeField is listTypeDescription
contextfalseReference Encounter or Episode during which the response was returned
dataRequirementtrueDataRequirement Additional required data
evaluationMessagetrueReference Messages resulting from the evaluation of the artifact or artifacts
identifierfalseIdentifier Business identifier
modulefalseReference A reference to a knowledge module
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
reasonCodeableConceptfalseCodeableConcept "reasonCodeableConcept" : { CodeableConcept },
reasonReferencefalseReference "reasonReference" : { Reference(Any) },
requestIdfalseid The id 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

{
  "status": "success",
  "reasonCodeableConcept": {
    "text": "Guideline Appropriate Ordering Assessment"
  },
  "performer": {
    "reference": "Device/software"
  },
  "resourceType": "GuidanceResponse",
  "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>requestId</b>: guidanceRequest1</p><p><b>identifier</b>: guidanceResponse1</p><p><b>module</b>: <a>ServiceDefinition/example</a></p><p><b>status</b>: success</p><p><b>subject</b>: <a>Patient/example</a></p><p><b>context</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>reason</b>: Guideline Appropriate Ordering Assessment <span>(Details )</span></p><p><b>outputParameters</b>: id: outputParameters1</p></div>"
  },
  "outputParameters": {
    "reference": "#outputParameters1"
  },
  "module": {
    "reference": "ServiceDefinition/example"
  },
  "contained": [
    {
      "resourceType": "Parameters",
      "parameter": [
        {
          "valueDecimal": 7,
          "name": "score"
        },
        {
          "valueCodeableConcept": {
            "coding": [
              {
                "code": "70450",
                "system": "http://www.ama-assn.org/go/cpt",
                "display": "CT, head, wo iv contrast"
              }
            ]
          },
          "name": "item-assessed"
        },
        {
          "valueReference": {
            "reference": "Device/software"
          },
          "name": "device"
        },
        {
          "valueUri": "http://someguidelineprovider.org/radiology-appropriateness-guidelines.html",
          "name": "guideline-followed"
        }
      ],
      "id": "outputParameters1"
    }
  ],
  "requestId": "guidanceRequest1",
  "context": {
    "reference": "Encounter/example"
  },
  "occurrenceDateTime": "2017-03-10T16:02:00Z",
  "identifier": {
    "system": "http://example.org",
    "value": "guidanceResponse1"
  },
  "id": "example",
  "subject": {
    "reference": "Patient/example"
  }
}

GuidanceResponse Structure


  
{
  "resourceType" : "GuidanceResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "requestId" : "<id>", // The id of the request associated with this response, if any
  "identifier" : { Identifier }, // Business identifier
  "module" : { Reference(ServiceDefinition) }, // R!  A reference to a knowledge module
  "status" : "<code>", // R!  success | data-requested | data-required | in-progress | failure | entered-in-error
  "subject" : { Reference(Patient|Group) }, // Patient the request was performed for
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or Episode during which the response was returned
  "occurrenceDateTime" : "<dateTime>", // When the guidance response was processed
  "performer" : { Reference(Device) }, // Device returning the guidance
  // reason[x]: Reason for the response. One of these 2:
  "reasonCodeableConcept" : { CodeableConcept },
  "reasonReference" : { Reference(Any) },
  "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 the like so:

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