GuidanceResponse

ResourceClinical · Request & ResponseTrial useMaturity 2

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.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

4 of 4 parameters tested

Structure

Show inherited elements (8)

Element	Card.	Type	Description
requestIdentifierΣ	0..1	Identifier	The identifier of the request associated with this response, if any
identifierΣ	0..*	Identifier	Business identifier
module[x]RequiredΣ	1..1	uri | canonical | CodeableConcept	What guidance was requested
statusRequired?!Σ	1..1	code	success | data-requested | data-required | in-progress | failure | entered-in-errorBinding (required): guidance-response-status
subject	0..1	Reference(Patient | Group)	Patient the request was performed for
encounter	0..1	Reference(Encounter)	Encounter during which the response was returned
occurrenceDateTime	0..1	dateTime	When the guidance response was processed
performer	0..1	Reference(Device)	Device returning the guidance
reasonCode	0..*	CodeableConcept	Why guidance is needed
reasonReference	0..*	Reference(Condition | Observation | DiagnosticReport | DocumentReference)	Why guidance is needed
note	0..*	Annotation	Additional notes about the response
evaluationMessage	0..*	Reference(OperationOutcome)	Messages resulting from the evaluation of the artifact or artifacts
outputParameters	0..1	Reference(Parameters)	The output parameters of the evaluation, if any
result	0..1	Reference(CarePlan | RequestGroup)	Proposed actions, if any
dataRequirement	0..*	DataRequirement	Additional required data

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/GuidanceResponse?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
identifier	token	The identifier of the guidance response GuidanceResponse.identifier
patient	reference	The identity of a patient to search for guidance response results GuidanceResponse.subject.where(resolve() is Patient)
request	token	The identifier of the request associated with the response GuidanceResponse.requestIdentifier
subject	reference	The subject that the guidance response is about GuidanceResponse.subject

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition