GuidanceResponse - FHIR Resource (stu3)
This GuidanceResponse Resource uses the FHIR API standard for access and structure.
Validate an GuidanceResponse FHIR Resource (stu3)
GuidanceResponse Attributes
AttributeField is listTypeDescription
Description: success | data-requested | data-required | in-progress | failure | entered-in-error
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "success"Learn more about the (GuidanceResponse) status FHIR attribute
Description: "reasonCodeableConcept" : { CodeableConcept },
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonCodeableConcept": {
"text": "Guideline Appropriate Ordering Assessment"
}Learn more about the (GuidanceResponse) reasonCodeableConcept FHIR attribute
Description: Device returning the guidance
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"performer": {
"reference": "Device/software"
}Learn more about the (GuidanceResponse) performer FHIR attribute
Description: "reasonReference" : { Reference(Any) },
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonReference": Learn more about the (GuidanceResponse) reasonReference FHIR attribute
Description: The output parameters of the evaluation, if any
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"outputParameters": {
"reference": "#outputParameters1"
}Learn more about the (GuidanceResponse) outputParameters FHIR attribute
Description: Patient the request was performed for
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": {
"reference": "Patient/example"
}Learn more about the (GuidanceResponse) subject FHIR attribute
Description: A reference to a knowledge module
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"module": {
"reference": "ServiceDefinition/example"
}Learn more about the (GuidanceResponse) module FHIR attribute
Description: Additional notes about the response
FHIR Version: stu3
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": Learn more about the (GuidanceResponse) note FHIR attribute
Description: Messages resulting from the evaluation of the artifact or artifacts
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"evaluationMessage": Learn more about the (GuidanceResponse) evaluationMessage FHIR attribute
Description: Proposed actions, if any
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"result": Learn more about the (GuidanceResponse) result FHIR attribute
Description: Encounter or Episode during which the response was returned
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"context": {
"reference": "Encounter/example"
}Learn more about the (GuidanceResponse) context FHIR attribute
Description: Additional required data
FHIR Version: stu3
Attribute Type : DataRequirement
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"dataRequirement": Learn more about the (GuidanceResponse) dataRequirement FHIR attribute
Description: When the guidance response was processed
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"occurrenceDateTime": "2017-03-10T16:02:00Z"Learn more about the (GuidanceResponse) occurrenceDateTime FHIR attribute
Description: Business identifier
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": {
"system": "http://example.org",
"value": "guidanceResponse1"
}Learn more about the (GuidanceResponse) identifier FHIR attribute
Description: The id of the request associated with this response, if any
FHIR Version: stu3
Attribute Type : id
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"requestId": "guidanceRequest1"Learn more about the (GuidanceResponse) requestId FHIR attribute
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 them like so:
https://api.1up.health/fhir/stu3/GuidanceResponse?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
identifier | text | identifier |
patient | reference | subject |
request | text | requestId |
subject | reference | subject |
