This page is part of the Da Vinci Data Exchange for Quality Measures (DEQM) FHIR IG (v4.0.0-ballot: STU4 (v4.0.0) Ballot 1) based on FHIR R4. The current version which supercedes this version is 3.1.0. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON
• TTL

Resource Profile: Detailed Care Gap Guidance Response

Detailed Care Gap Guidance Response

Usage:

• Examples for this Resource Profile: GuidanceResponse/guidanceresponse01

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from GuidanceResponse

Name	Flags	Card.	Type	Description & Constraints
GuidanceResponse		0..*	GuidanceResponse	The formal response to a guidance request
reasonCode		0..*	CodeableConcept	Why guidance is needed Binding: Care Gap Reasons Value Set (preferred)
detail		0..1	(Complex)	Which data element attribute is the cause of the care gap URL: http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/reasonDetail
dataRequirement
valueFilter		0..*	(Complex)	What values are expected URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-valueFilter
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
GuidanceResponse.reasonCode	preferred	CareGapReasons (a valid code from Care Gap Reasons Code System)

Name	Flags	Card.	Type	Description & Constraints
GuidanceResponse		0..*	GuidanceResponse	The formal response to a guidance request
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
module[x]	Σ	1..1		What guidance was requested
moduleUri			uri
moduleCanonical			canonical(Any)
moduleCodeableConcept			CodeableConcept
status	?!Σ	1..1	code	success | data-requested | data-required | in-progress | failure | entered-in-error Binding: GuidanceResponseStatus (required): The status of a guidance response.
reasonCode		0..*	CodeableConcept	Why guidance is needed Binding: Care Gap Reasons Value Set (preferred)
detail		0..1	(Complex)	Which data element attribute is the cause of the care gap URL: http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/reasonDetail
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
GuidanceResponse.status	required	GuidanceResponseStatus
GuidanceResponse.reasonCode	preferred	CareGapReasons (a valid code from Care Gap Reasons Code System)

Name	Flags	Card.	Type	Description & Constraints
GuidanceResponse		0..*	GuidanceResponse	The formal response to a guidance request
id	Σ	0..1	id	Logical id of this artifact
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 Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
requestIdentifier	Σ	0..1	Identifier	The identifier of the request associated with this response, if any
identifier	Σ	0..*	Identifier	Business identifier
module[x]	Σ	1..1		What guidance was requested
moduleUri			uri
moduleCanonical			canonical(Any)
moduleCodeableConcept			CodeableConcept
status	?!Σ	1..1	code	success | data-requested | data-required | in-progress | failure | entered-in-error Binding: GuidanceResponseStatus (required): The status of a guidance response.
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 Binding: Care Gap Reasons Value Set (preferred)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
detail		0..1	(Complex)	Which data element attribute is the cause of the care gap URL: http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/reasonDetail
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
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
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
valueFilter		0..*	(Complex)	What values are expected URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-valueFilter
type	Σ	1..1	code	The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile	Σ	0..*	canonical(StructureDefinition)	The profile of the required data
subject[x]	Σ	0..1		E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference(Group)
mustSupport	Σ	0..*	string	Indicates specific structure elements that are referenced by the knowledge module
codeFilter	ΣC	0..*	Element	What codes are expected
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
path	Σ	0..1	string	A code-valued attribute to filter on
searchParam	Σ	0..1	string	A coded (token) parameter to search on
valueSet	Σ	0..1	canonical(ValueSet)	Valueset for the filter
code	Σ	0..*	Coding	What code is expected
dateFilter	ΣC	0..*	Element	What dates/date ranges are expected
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
path	Σ	0..1	string	A date-valued attribute to filter on
searchParam	Σ	0..1	string	A date valued parameter to search on
value[x]	Σ	0..1		The value of the filter, as a Period, DateTime, or Duration value
valueDateTime			dateTime
valuePeriod			Period
valueDuration			Duration
limit	Σ	0..1	positiveInt	Number of results
sort	Σ	0..*	Element	Order of the results
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
path	Σ	1..1	string	The name of the attribute to perform the sort
direction	Σ	1..1	code	ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
GuidanceResponse.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
GuidanceResponse.status	required	GuidanceResponseStatus
GuidanceResponse.reasonCode	preferred	CareGapReasons (a valid code from Care Gap Reasons Code System)
GuidanceResponse.dataRequirement.type	required	FHIRAllTypes
GuidanceResponse.dataRequirement.subject[x]	extensible	SubjectType
GuidanceResponse.dataRequirement.sort.direction	required	SortDirection

This structure is derived from GuidanceResponse

Summary

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/reasonDetail
• http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-valueFilter

Differential View

This structure is derived from GuidanceResponse

Name	Flags	Card.	Type	Description & Constraints
GuidanceResponse		0..*	GuidanceResponse	The formal response to a guidance request
reasonCode		0..*	CodeableConcept	Why guidance is needed Binding: Care Gap Reasons Value Set (preferred)
detail		0..1	(Complex)	Which data element attribute is the cause of the care gap URL: http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/reasonDetail
dataRequirement
valueFilter		0..*	(Complex)	What values are expected URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-valueFilter
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
GuidanceResponse.reasonCode	preferred	CareGapReasons (a valid code from Care Gap Reasons Code System)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
GuidanceResponse		0..*	GuidanceResponse	The formal response to a guidance request
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
module[x]	Σ	1..1		What guidance was requested
moduleUri			uri
moduleCanonical			canonical(Any)
moduleCodeableConcept			CodeableConcept
status	?!Σ	1..1	code	success | data-requested | data-required | in-progress | failure | entered-in-error Binding: GuidanceResponseStatus (required): The status of a guidance response.
reasonCode		0..*	CodeableConcept	Why guidance is needed Binding: Care Gap Reasons Value Set (preferred)
detail		0..1	(Complex)	Which data element attribute is the cause of the care gap URL: http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/reasonDetail
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
GuidanceResponse.status	required	GuidanceResponseStatus
GuidanceResponse.reasonCode	preferred	CareGapReasons (a valid code from Care Gap Reasons Code System)

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
GuidanceResponse		0..*	GuidanceResponse	The formal response to a guidance request
id	Σ	0..1	id	Logical id of this artifact
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 Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
requestIdentifier	Σ	0..1	Identifier	The identifier of the request associated with this response, if any
identifier	Σ	0..*	Identifier	Business identifier
module[x]	Σ	1..1		What guidance was requested
moduleUri			uri
moduleCanonical			canonical(Any)
moduleCodeableConcept			CodeableConcept
status	?!Σ	1..1	code	success | data-requested | data-required | in-progress | failure | entered-in-error Binding: GuidanceResponseStatus (required): The status of a guidance response.
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 Binding: Care Gap Reasons Value Set (preferred)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
detail		0..1	(Complex)	Which data element attribute is the cause of the care gap URL: http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/reasonDetail
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept
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
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
valueFilter		0..*	(Complex)	What values are expected URL: http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-valueFilter
type	Σ	1..1	code	The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
profile	Σ	0..*	canonical(StructureDefinition)	The profile of the required data
subject[x]	Σ	0..1		E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference(Group)
mustSupport	Σ	0..*	string	Indicates specific structure elements that are referenced by the knowledge module
codeFilter	ΣC	0..*	Element	What codes are expected
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
path	Σ	0..1	string	A code-valued attribute to filter on
searchParam	Σ	0..1	string	A coded (token) parameter to search on
valueSet	Σ	0..1	canonical(ValueSet)	Valueset for the filter
code	Σ	0..*	Coding	What code is expected
dateFilter	ΣC	0..*	Element	What dates/date ranges are expected
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
path	Σ	0..1	string	A date-valued attribute to filter on
searchParam	Σ	0..1	string	A date valued parameter to search on
value[x]	Σ	0..1		The value of the filter, as a Period, DateTime, or Duration value
valueDateTime			dateTime
valuePeriod			Period
valueDuration			Duration
limit	Σ	0..1	positiveInt	Number of results
sort	Σ	0..*	Element	Order of the results
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
path	Σ	1..1	string	The name of the attribute to perform the sort
direction	Σ	1..1	code	ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
GuidanceResponse.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
GuidanceResponse.status	required	GuidanceResponseStatus
GuidanceResponse.reasonCode	preferred	CareGapReasons (a valid code from Care Gap Reasons Code System)
GuidanceResponse.dataRequirement.type	required	FHIRAllTypes
GuidanceResponse.dataRequirement.subject[x]	extensible	SubjectType
GuidanceResponse.dataRequirement.sort.direction	required	SortDirection

This structure is derived from GuidanceResponse

Summary

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/reasonDetail
• http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-valueFilter

Other representations of profile: CSV, Excel, Schematron