Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Guidance Response Implementation Guidance

GuidanceResponse implementation guidance

GuidanceResponse: Implementation Guidance

Usage

The table below details implementation guidance for the GuidanceResponse resource in the scope of this implementation guide:

Name Cardinality Type FHIR Documentation CDS Implementation Guidance
id 0..1 id Logical id of this artifact Note that this will always be populated except when the resource is being created (initial creation call)
meta 0..1 Meta Metadata about the resource
implicitRules 0..1 uri A set of rules under which this content was created
language 0..1 code Language of the resource content.
Common Languages (Extensible but limited to All Languages)
text 0..1 Narrative Text summary of the resource, for human interpretation
contained 0..* Resource Contained, inline Resources This SHOULD NOT be populated
extension 0..* Extension Additional Content defined by implementations
modifierExtension 0..* Extension Extensions that cannot be ignored
requestId 0..1 id The id of the request associated with this response, if any. This MUST be populated by the CDSS and MUST replicate the requestId received by the CDSS as a parameter in the ServiceDefinition.$evaluate operation.
identifier 0..1 Identifier Business identifier This MUST NOT be populated by the CDSS.
module 1..1 Reference
(ServiceDefinition)
A reference to a knowledge module. This MUST be populated with a reference to the ServiceDefinition posted to the CDSS in the ServiceDefinition.$evaluate operation.
status 1..1 code Code datatype with Required binding to GuidanceResponseStatus This MUST be populated with either `success`, `data-requested`, `data-required` or `failure`. Other statuses are not valid.
subject 0..1 Reference
(Patient |
Group)
Patient the request was performed for. This MUST be populated with a reference to the Patient resource.
context 0..1 Reference
(Encounter |
EpisodeOfCare)
Encounter or Episode during which the response was returned. This MUST be populated with the Encounter for this journey, from the ServiceDefinition.$evaluate.encounter
occurrenceDateTime 0..1 dateTime When the guidance response was processed. This MUST be populated by the CDSS. It represents the date/time at which the GuidanceResponse is processed by the CDSS. (This may differ from the time the message is received).
performer 0..1 Reference
(Device)
Device returning the guidance. This MUST NOT be populated.
reason[x] 0..1 CodeableConcept |
Reference
Reason for the response. This MUST NOT be populated.
note 0..* CodeableConcept |
Annotation
Additional notes about the response. This MUST NOT be populated.
evaluationMessage 0..* Reference
(OperationOutcome)
Messages resulting from the evaluation of the artifact or artifacts. This MUST ONLY be populated in the case of error. Where populated this MUST be processed appropriately by the EMS.
outputParameters 0..1 Reference
(Parameters)
The output parameters of the evaluation, if any. This element carries the state of the patient triage and MUST be populated with the current state. The state is managed through:
  • QuestionnaireResponse elements (as provided by the user)
  • assertions (typically populated as Observation resources) based on these responses which can be interpreted by other systems
  • and any other resources provided by the EMS, typically from external systems (e.g. known patient conditions).
Where an outputParameter can be interpreted by a system, it SHOULD be published as an assertion, typically an Observation. If the information can only be interpreted by a human, it can be published as a QuestionnaireResponse only.
result 0..1 Reference
(CarePlan |
RequestGroup)
Proposed actions, if any. This MUST only be populated by a RequestGroup resource, and MUST NOT be populated with a CarePlan.
This MUST ONLY be populated if the CDS has either a recommendation for next service, or care advice for the patient.
This SHOULD NOT be populated with a final result or care advice when recommending transfer to another ServiceDefinition, but can be populated with an interim result.
dataRequirement 0..* DataRequirement Additional required data. This MUST ONLY be populated with a Questionnaire if the GuidanceResponse.status is set to data-requested or data-required. This MUST ONLY be populated with a Trigger Definition if the GuidanceResponse.status is set to 'Success' and the GuidanceResponse.result is NOT set to 'Final Result' This MUST NOT be populated if GuidanceResponse.status is set to Success and GuidanceResponse.result is set to 'Final Result'

GuidanceResponse Elements of note

OutputParameters element of the GuidanceResponse

This element contains the output parameters of the evaluation and is critical because it carries the current state of the triage journey.

Result element of the GuidanceResponse

Further guidance about the population of this element can be viewed on the Evaluate Response page.

DataRequirement element of the GuidanceResponse

The scenarios in which this element MAY be used are outlined below:-

Evaluation against the currently selected ServiceDefinition

If information is lacking for the evaluation to be completed or additional information could result in a more accurate response, this element will carry a description of the data required in order to proceed with the evaluation. A subsequent request to the service SHOULD include this data.

Re-direction to a new ServiceDefinition

In this scenario, the element will carry a description of the data required by the EMS to select the new ServiceDefinition to which it is being re-directed by the CDSS.
The dataRequirement.type element will be ‘TriggerDefinition’ and the CDSS will populate this to match the contents of the ServiceDefinition.trigger.eventData for the ServiceDefinition to which the EMS is to be re-directed.

Tags: rest fhir api

All content is available under the Open Government Licence v3.0, except where otherwise stated