GuidanceResponse

A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

Interaction	Method	Path
Read	GET	/fhir/R4/GuidanceResponse/[id]
Vread	GET	/fhir/R4/GuidanceResponse/[id]/_history/[vid]
Update	PUT	/fhir/R4/GuidanceResponse/[id]
Patch	PATCH	/fhir/R4/GuidanceResponse/[id]
Delete	DELETE	/fhir/R4/GuidanceResponse/[id]
Create	POST	/fhir/R4/GuidanceResponse
Search	GET	/fhir/R4/GuidanceResponse
History	GET	/fhir/R4/GuidanceResponse/[id]/_history

Top-level elements

Element	Type	Cardinality	Description
id	string	0..1	Logical id of this artifact
meta	Meta	0..1	Metadata about the resource
implicitRules	uri	0..1	A set of rules under which this content was created
language	code	0..1	Language of the resource content
text	Narrative	0..1	Text summary of the resource, for human interpretation
contained	Resource	0..*	Contained, inline Resources
extension	Extension	0..*	Additional content defined by implementations
modifierExtension	Extension	0..*	Extensions that cannot be ignored
requestIdentifier	Identifier	0..1	The identifier of the request associated with this response, if any
identifier	Identifier	0..*	Business identifier
module[x]	uri, canonical, CodeableConcept	1..1	What guidance was requested
status	code	1..1	success | data-requested | data-required | in-progress | failure | entered-in-error
subject	Reference	0..1	Patient the request was performed for
encounter	Reference	0..1	Encounter during which the response was returned
occurrenceDateTime	dateTime	0..1	When the guidance response was processed
performer	Reference	0..1	Device returning the guidance
reasonCode	CodeableConcept	0..*	Why guidance is needed
reasonReference	Reference	0..*	Why guidance is needed
note	Annotation	0..*	Additional notes about the response
evaluationMessage	Reference	0..*	Messages resulting from the evaluation of the artifact or artifacts
outputParameters	Reference	0..1	The output parameters of the evaluation, if any
result	Reference	0..1	Proposed actions, if any
dataRequirement	DataRequirement	0..*	Additional required data

Resource-specific search parameters

Parameter	Type	Description
identifier	token	The identifier of the guidance response
patient	reference	The identity of a patient to search for guidance response results
request	token	The identifier of the request associated with the response
subject	reference	The subject that the guidance response is about

Reference

Official FHIR R4 spec: GuidanceResponse.
Maturity: Trial Use 2 (FMM 2).