Data Exchange For Quality Measures Implementation Guide
5.0.0 - STU5
Data Exchange For Quality Measures Implementation Guide
5.0.0 - STU5
This page is part of the Da Vinci Data Exchange for Quality Measures (DEQM) FHIR IG (v5.0.0: STU5 (v5.0.0)) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/gaps-guidanceresponse-detailedcaregap | Version: 5.0.0 | |||
| Standards status: Trial-use | Maturity Level: 4 | 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.
The following data-elements are mandatory (i.e data MUST be present).
Each GuidanceResponse Must Have:
More guidance can be found here.
The following data-elements are mandatory (i.e data MUST be present).
Each must have:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  GuidanceResponse |
0..* | GuidanceResponse | The formal response to a guidance request dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 module[x] |
Σ | 1..1 | What guidance was requested ele-1: All FHIR elements must have a @value or children | |
 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. ele-1: All FHIR elements must have a @value or children |
| reasonCode |
0..* | CodeableConcept | Why guidance is needed Binding: Care Gap Reasons Value Set (preferred) ele-1: All FHIR elements must have a @value or children | |
  Slices for extension |
Content/Rules for all slices | |||
  extension: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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| GuidanceResponse.status | required | GuidanceResponseStatushttp://hl7.org/fhir/ValueSet/guidance-response-status|4.0.1from the FHIR Standard | |
| GuidanceResponse.reasonCode | preferred | CareGapReasons (a valid code from Care Gap Reasons Code System)http://hl7.org/fhir/us/davinci-deqm/ValueSet/care-gap-reasonfrom this IG |
This structure is derived from GuidanceResponse
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| GuidanceResponse |
GuidanceResponse | |||
 reasonCode |
0..* | CodeableConcept | Why guidance is needed Binding: Care Gap Reasons Value Set (preferred) | |
| Slices for extension |
Content/Rules for all slices | |||
| extension: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 | |||
| extension:valueFilter |
0..* | (Complex) | What values are expected URL: http://hl7.org/fhir/StructureDefinition/cqf-valueFilter | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| GuidanceResponse.reasonCode | preferred | CareGapReasons (a valid code from Care Gap Reasons Code System)http://hl7.org/fhir/us/davinci-deqm/ValueSet/care-gap-reasonfrom this IG |
| 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.
| |||||
| 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 | |||||
| extension: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 | |||||
| extension: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. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| GuidanceResponse.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| GuidanceResponse.status | required | GuidanceResponseStatushttp://hl7.org/fhir/ValueSet/guidance-response-status|4.0.1from the FHIR Standard | ||||
| GuidanceResponse.reasonCode | preferred | CareGapReasons (a valid code from Care Gap Reasons Code System)http://hl7.org/fhir/us/davinci-deqm/ValueSet/care-gap-reasonfrom this IG | ||||
| GuidanceResponse.dataRequirement.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1from the FHIR Standard | ||||
| GuidanceResponse.dataRequirement.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| GuidanceResponse.dataRequirement.sort.direction | required | SortDirectionhttp://hl7.org/fhir/ValueSet/sort-direction|4.0.1from the FHIR Standard |
This structure is derived from GuidanceResponse
Summary
Extensions
This structure refers to these extensions:
Maturity: 4
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| GuidanceResponse |
0..* | GuidanceResponse | The formal response to a guidance request dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| module[x] |
Σ | 1..1 | What guidance was requested ele-1: All FHIR elements must have a @value or children | |
| 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. ele-1: All FHIR elements must have a @value or children |
| reasonCode |
0..* | CodeableConcept | Why guidance is needed Binding: Care Gap Reasons Value Set (preferred) ele-1: All FHIR elements must have a @value or children | |
| Slices for extension |
Content/Rules for all slices | |||
| extension: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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| GuidanceResponse.status | required | GuidanceResponseStatushttp://hl7.org/fhir/ValueSet/guidance-response-status|4.0.1from the FHIR Standard | |
| GuidanceResponse.reasonCode | preferred | CareGapReasons (a valid code from Care Gap Reasons Code System)http://hl7.org/fhir/us/davinci-deqm/ValueSet/care-gap-reasonfrom this IG |
Differential View
This structure is derived from GuidanceResponse
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| GuidanceResponse |
GuidanceResponse | |||
| reasonCode |
0..* | CodeableConcept | Why guidance is needed Binding: Care Gap Reasons Value Set (preferred) | |
| Slices for extension |
Content/Rules for all slices | |||
| extension: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 | |||
| extension:valueFilter |
0..* | (Complex) | What values are expected URL: http://hl7.org/fhir/StructureDefinition/cqf-valueFilter | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| GuidanceResponse.reasonCode | preferred | CareGapReasons (a valid code from Care Gap Reasons Code System)http://hl7.org/fhir/us/davinci-deqm/ValueSet/care-gap-reasonfrom this IG |
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.
| |||||
| 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 | |||||
| extension: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 | |||||
| extension: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. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| GuidanceResponse.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| GuidanceResponse.status | required | GuidanceResponseStatushttp://hl7.org/fhir/ValueSet/guidance-response-status|4.0.1from the FHIR Standard | ||||
| GuidanceResponse.reasonCode | preferred | CareGapReasons (a valid code from Care Gap Reasons Code System)http://hl7.org/fhir/us/davinci-deqm/ValueSet/care-gap-reasonfrom this IG | ||||
| GuidanceResponse.dataRequirement.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1from the FHIR Standard | ||||
| GuidanceResponse.dataRequirement.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| GuidanceResponse.dataRequirement.sort.direction | required | SortDirectionhttp://hl7.org/fhir/ValueSet/sort-direction|4.0.1from the FHIR Standard |
This structure is derived from GuidanceResponse
Summary
Extensions
This structure refers to these extensions:
Maturity: 4
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Clinical Quality Information. Package hl7.fhir.us.davinci-deqm#5.0.0 based on FHIR 4.0.1. Generated 2025-05-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change