GuidanceResponse

Trial Use 2 Clinical — Care Provision

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.

Endpoints

alphahttps://api.dev.ovok.com/fhir/R4/GuidanceResponse

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(s)	Cardinality	Description
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 modifier
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
_compartment	string
_count	string	https://www.hl7.org/fhir/search.html#_count
_elements	string	https://www.hl7.org/fhir/search.html#_elements
_id	string
_lastUpdated	string
_profile	string
_security	string
_sort	string	https://www.hl7.org/fhir/search.html#_sort
_source	string
_summary	string	https://www.hl7.org/fhir/search.html#_summary
_tag	string
_total	string	https://www.hl7.org/fhir/search.html#_total
identifier	string	http://hl7.org/fhir/SearchParameter/GuidanceResponse-identifier
patient	string	http://hl7.org/fhir/SearchParameter/GuidanceResponse-patient
request	string	http://hl7.org/fhir/SearchParameter/GuidanceResponse-request
subject	string	http://hl7.org/fhir/SearchParameter/GuidanceResponse-subject

Reference

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