GuidanceResponse - FHIR Resource (r4)
This GuidanceResponse Resource uses the FHIR API standard for access and structure.
Validate an GuidanceResponse FHIR Resource (r4)
GuidanceResponse Attributes
AttributeField is listTypeDescription
Description: The identifier of the request associated with this response, if any
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"requestIdentifier": {
"system": "http://example.org",
"value": "guidanceRequest1"
}Learn more about the (GuidanceResponse) requestIdentifier FHIR attribute
Description: Business identifier
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
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:
FHIR Version: r4
Attribute Type : uri|canonical|CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"module[x]": Learn more about the (GuidanceResponse) module[x] FHIR attribute
Description: success | data-requested | data-required | in-progress | failure | entered-in-error
FHIR Version: r4
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: Patient the request was performed for
FHIR Version: r4
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: Encounter during which the response was returned
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"encounter": {
"reference": "Encounter/example"
}Learn more about the (GuidanceResponse) encounter FHIR attribute
Description: When the guidance response was processed
FHIR Version: r4
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: Device returning the guidance
FHIR Version: r4
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: Why guidance is needed
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonCode": [
{
"text": "Guideline Appropriate Ordering Assessment"
}
]Learn more about the (GuidanceResponse) reasonCode FHIR attribute
Description: "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonReference": Learn more about the (GuidanceResponse) reasonReference FHIR attribute
Description: Additional notes about the response
FHIR Version: r4
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: r4
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: The output parameters of the evaluation, if any
FHIR Version: r4
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: Proposed actions, if any
FHIR Version: r4
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: Additional required data
FHIR Version: r4
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
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 Parameter | Field Type | Resource Fields Searched |
|---|---|---|
identifier | text | identifier |
patient | reference | subject.where |
request | text | requestIdentifier |
subject | reference | subject |
