Data Exchange For Quality Measures Implementation Guide
5.0.0-ballot - STU5 Ballot United States of America flag

This page is part of the Da Vinci Data Exchange for Quality Measures (DEQM) FHIR IG (v5.0.0-ballot: STU5 (v5.0.0) Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: Detailed Care Gap Guidance Response

Official URL: http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/gaps-guidanceresponse-detailedcaregap Version: 5.0.0-ballot
Active as of 2024-08-27 Computable Name: DetailedCareGapGuidanceResponse
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.25

Derived from the GuidanceResponse resource, the Detailed Care Gap Guidance Response profile supports the functionality of providing reason for guidance and detailed guidance to help address care gaps and close open gaps.

Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present).

Each GuidanceResponse Must Have:

  1. module[x]: What guidance was requested
  2. status: success | data-requested | data-required | in-progress | failure | entered-in-error
  3. dataRequirement.type: The type of the required data
  4. dataRequirement.sort.path: The name of the attribute to perform the sort
  5. dataRequirement.sort.direction: ascending | descending

More guidance can be found here.

Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present).

Each must have:

Usage:

Formal Views of Profile Content

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

This structure is derived from GuidanceResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse GuidanceResponse
... reasonCode 0..* CodeableConcept Why guidance is needed
Binding: Care Gap Reasons Value Set (preferred)
.... Slices for extension Content/Rules for all slices
..... 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
.... Slices for extension Content/Rules for all slices
..... valueFilter 0..* (Complex) What values are expected
URL: http://hl7.org/fhir/StructureDefinition/cqf-valueFilter

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
GuidanceResponse.reasonCodepreferredCareGapReasons (a valid code from Care Gap Reasons Code System)
http://hl7.org/fhir/us/davinci-deqm/ValueSet/care-gap-reason
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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)
.... Slices for extension Content/Rules for all slices
..... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
GuidanceResponse.statusrequiredGuidanceResponseStatus
http://hl7.org/fhir/ValueSet/guidance-response-status|4.0.1
from the FHIR Standard
GuidanceResponse.reasonCodepreferredCareGapReasons (a valid code from Care Gap Reasons Code System)
http://hl7.org/fhir/us/davinci-deqm/ValueSet/care-gap-reason
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 BindingsPurpose
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/StructureDefinition/cqf-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
drq-1: Either a path or a searchParam must be provided, but not both
..... 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
drq-2: Either a path or a searchParam must be provided, but not both
..... 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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
GuidanceResponse.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
GuidanceResponse.statusrequiredGuidanceResponseStatus
http://hl7.org/fhir/ValueSet/guidance-response-status|4.0.1
from the FHIR Standard
GuidanceResponse.reasonCodepreferredCareGapReasons (a valid code from Care Gap Reasons Code System)
http://hl7.org/fhir/us/davinci-deqm/ValueSet/care-gap-reason
from this IG
GuidanceResponse.dataRequirement.typerequiredFHIRAllTypes
http://hl7.org/fhir/ValueSet/all-types|4.0.1
from the FHIR Standard
GuidanceResponse.dataRequirement.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
from the FHIR Standard
GuidanceResponse.dataRequirement.sort.directionrequiredSortDirection
http://hl7.org/fhir/ValueSet/sort-direction|4.0.1
from the FHIR Standard

This structure is derived from GuidanceResponse

Differential View

This structure is derived from GuidanceResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse GuidanceResponse
... reasonCode 0..* CodeableConcept Why guidance is needed
Binding: Care Gap Reasons Value Set (preferred)
.... Slices for extension Content/Rules for all slices
..... 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
.... Slices for extension Content/Rules for all slices
..... valueFilter 0..* (Complex) What values are expected
URL: http://hl7.org/fhir/StructureDefinition/cqf-valueFilter

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
GuidanceResponse.reasonCodepreferredCareGapReasons (a valid code from Care Gap Reasons Code System)
http://hl7.org/fhir/us/davinci-deqm/ValueSet/care-gap-reason
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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)
.... Slices for extension Content/Rules for all slices
..... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
GuidanceResponse.statusrequiredGuidanceResponseStatus
http://hl7.org/fhir/ValueSet/guidance-response-status|4.0.1
from the FHIR Standard
GuidanceResponse.reasonCodepreferredCareGapReasons (a valid code from Care Gap Reasons Code System)
http://hl7.org/fhir/us/davinci-deqm/ValueSet/care-gap-reason
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 BindingsPurpose
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/StructureDefinition/cqf-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
drq-1: Either a path or a searchParam must be provided, but not both
..... 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
drq-2: Either a path or a searchParam must be provided, but not both
..... 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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
GuidanceResponse.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
GuidanceResponse.statusrequiredGuidanceResponseStatus
http://hl7.org/fhir/ValueSet/guidance-response-status|4.0.1
from the FHIR Standard
GuidanceResponse.reasonCodepreferredCareGapReasons (a valid code from Care Gap Reasons Code System)
http://hl7.org/fhir/us/davinci-deqm/ValueSet/care-gap-reason
from this IG
GuidanceResponse.dataRequirement.typerequiredFHIRAllTypes
http://hl7.org/fhir/ValueSet/all-types|4.0.1
from the FHIR Standard
GuidanceResponse.dataRequirement.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
from the FHIR Standard
GuidanceResponse.dataRequirement.sort.directionrequiredSortDirection
http://hl7.org/fhir/ValueSet/sort-direction|4.0.1
from the FHIR Standard

This structure is derived from GuidanceResponse

 

Other representations of profile: CSV, Excel, Schematron