Data Exchange For Quality Measures STU3 for FHIR R4
2.1.0 - Ballot

This page is part of the Da Vinci Data Exchange for Quality Measures (DEQM) FHIR IG (v2.1.0: STU 3) 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

Resource Profile: DEQMGapsInCareBundleProfile

The DEQM Gaps In Care Bundle Profile describes a bundle returned by the Measure care-gaps operation. This bundle consists of a document composition for gaps in care and supporting resources referenced by the composition.

The official URL for this profile is:

http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/gaps-bundle-deqm

ONLY the new content for Gaps in Care is in the scope for ballot for the September, 2020 Ballot Cycle.

This profile builds on Bundle.

Mandatory Data Elements and Terminology

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

Each must have:

  1. A bundle type hardcoded to “document”
  2. An entry references a composition using the DEQM Gaps In Care Composition Profile for a measure

Each should have (Must Support):

  1. An entry references a MeasureReport using the DEQM Gaps In Care Individual MeasureReport Profile for each measure referenced in the composition.

Formal Views of Profile Content

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

This structure is derived from Bundle

Summary

Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 5 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Bundle.entry is sliced based on the value of type:resource

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..*BundleContains a collection of resources
... type 1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: document
... entry S1..*(Slice Definition)Entry in the bundle - will have a resource or information
Slice: Unordered, Open by type:resource
.... entry:gaps_composition_entry S1..1BackboneElementContains a composition of gaps in care report for an individual for one or more measures
..... resource S1..1DEQMGapsInCareCompositionProfileThis Composition uses the DEQM Gaps In Care Composition Profile
.... entry:gaps_indv_measure_report_entry S0..*BackboneElementContains the gaps in care individual MeasureReport referenced in the gaps in care composition
..... resource S1..1DEQMGapsInCareIndividualMeasureReportProfileThis MeasureReport uses the DEQM Gaps In Care Individual MeasureReport Profile

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*BundleContains a collection of resources
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... identifier ΣI0..1IdentifierPersistent identifier for the bundle
... type ΣI1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required)
Fixed Value: document
... timestamp ΣI0..1instantWhen the bundle was assembled
... total ΣI0..1unsignedIntIf search, the total number of matches
... link ΣI0..*BackboneElementLinks related to this Bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation ΣI1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url ΣI1..1uriReference details for the link
... entry SΣI1..*(Slice Definition)Entry in the bundle - will have a resource or information
Slice: Unordered, Open by type:resource
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*See linkLinks related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ0..1ResourceA resource in the bundle
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score ΣI0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
...... url ΣI1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch ΣI0..1stringFor managing cache currency
...... ifModifiedSince ΣI0..1instantFor managing cache currency
...... ifMatch ΣI0..1stringFor managing update contention
...... ifNoneExist ΣI0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status ΣI1..1stringStatus response code (text optional)
...... location ΣI0..1uriThe location (if the operation returns a location)
...... etag ΣI0..1stringThe Etag for the resource (if relevant)
...... lastModified ΣI0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:gaps_composition_entry SΣI1..1BackboneElementContains a composition of gaps in care report for an individual for one or more measures
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*See linkLinks related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SI1..1DEQMGapsInCareCompositionProfileThis Composition uses the DEQM Gaps In Care Composition Profile
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score ΣI0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
...... url ΣI1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch ΣI0..1stringFor managing cache currency
...... ifModifiedSince ΣI0..1instantFor managing cache currency
...... ifMatch ΣI0..1stringFor managing update contention
...... ifNoneExist ΣI0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status ΣI1..1stringStatus response code (text optional)
...... location ΣI0..1uriThe location (if the operation returns a location)
...... etag ΣI0..1stringThe Etag for the resource (if relevant)
...... lastModified ΣI0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:gaps_indv_measure_report_entry SΣI0..*BackboneElementContains the gaps in care individual MeasureReport referenced in the gaps in care composition
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*See linkLinks related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SI1..1DEQMGapsInCareIndividualMeasureReportProfileThis MeasureReport uses the DEQM Gaps In Care Individual MeasureReport Profile
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score ΣI0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
...... url ΣI1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch ΣI0..1stringFor managing cache currency
...... ifModifiedSince ΣI0..1instantFor managing cache currency
...... ifMatch ΣI0..1stringFor managing update contention
...... ifNoneExist ΣI0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status ΣI1..1stringStatus response code (text optional)
...... location ΣI0..1uriThe location (if the operation returns a location)
...... etag ΣI0..1stringThe Etag for the resource (if relevant)
...... lastModified ΣI0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature ΣI0..1SignatureDigital Signature

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*BundleContains a collection of resources
... entry ΣI1..*(Slice Definition)Entry in the bundle - will have a resource or information
Slice: Unordered, Open by type:resource
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:gaps_composition_entry ΣI1..1BackboneElementContains a composition of gaps in care report for an individual for one or more measures
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... resource I1..1DEQMGapsInCareCompositionProfileThis Composition uses the DEQM Gaps In Care Composition Profile
.... entry:gaps_indv_measure_report_entry ΣI0..*BackboneElementContains the gaps in care individual MeasureReport referenced in the gaps in care composition
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... resource I1..1DEQMGapsInCareIndividualMeasureReportProfileThis MeasureReport uses the DEQM Gaps In Care Individual MeasureReport Profile

doco Documentation for this format

This structure is derived from Bundle

Summary

Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 5 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Bundle.entry is sliced based on the value of type:resource

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..*BundleContains a collection of resources
... type 1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: document
... entry S1..*(Slice Definition)Entry in the bundle - will have a resource or information
Slice: Unordered, Open by type:resource
.... entry:gaps_composition_entry S1..1BackboneElementContains a composition of gaps in care report for an individual for one or more measures
..... resource S1..1DEQMGapsInCareCompositionProfileThis Composition uses the DEQM Gaps In Care Composition Profile
.... entry:gaps_indv_measure_report_entry S0..*BackboneElementContains the gaps in care individual MeasureReport referenced in the gaps in care composition
..... resource S1..1DEQMGapsInCareIndividualMeasureReportProfileThis MeasureReport uses the DEQM Gaps In Care Individual MeasureReport Profile

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*BundleContains a collection of resources
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... identifier ΣI0..1IdentifierPersistent identifier for the bundle
... type ΣI1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required)
Fixed Value: document
... timestamp ΣI0..1instantWhen the bundle was assembled
... total ΣI0..1unsignedIntIf search, the total number of matches
... link ΣI0..*BackboneElementLinks related to this Bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation ΣI1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url ΣI1..1uriReference details for the link
... entry SΣI1..*(Slice Definition)Entry in the bundle - will have a resource or information
Slice: Unordered, Open by type:resource
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*See linkLinks related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ0..1ResourceA resource in the bundle
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score ΣI0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
...... url ΣI1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch ΣI0..1stringFor managing cache currency
...... ifModifiedSince ΣI0..1instantFor managing cache currency
...... ifMatch ΣI0..1stringFor managing update contention
...... ifNoneExist ΣI0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status ΣI1..1stringStatus response code (text optional)
...... location ΣI0..1uriThe location (if the operation returns a location)
...... etag ΣI0..1stringThe Etag for the resource (if relevant)
...... lastModified ΣI0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:gaps_composition_entry SΣI1..1BackboneElementContains a composition of gaps in care report for an individual for one or more measures
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*See linkLinks related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SI1..1DEQMGapsInCareCompositionProfileThis Composition uses the DEQM Gaps In Care Composition Profile
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score ΣI0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
...... url ΣI1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch ΣI0..1stringFor managing cache currency
...... ifModifiedSince ΣI0..1instantFor managing cache currency
...... ifMatch ΣI0..1stringFor managing update contention
...... ifNoneExist ΣI0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status ΣI1..1stringStatus response code (text optional)
...... location ΣI0..1uriThe location (if the operation returns a location)
...... etag ΣI0..1stringThe Etag for the resource (if relevant)
...... lastModified ΣI0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:gaps_indv_measure_report_entry SΣI0..*BackboneElementContains the gaps in care individual MeasureReport referenced in the gaps in care composition
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*See linkLinks related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SI1..1DEQMGapsInCareIndividualMeasureReportProfileThis MeasureReport uses the DEQM Gaps In Care Individual MeasureReport Profile
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score ΣI0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
...... url ΣI1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch ΣI0..1stringFor managing cache currency
...... ifModifiedSince ΣI0..1instantFor managing cache currency
...... ifMatch ΣI0..1stringFor managing update contention
...... ifNoneExist ΣI0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status ΣI1..1stringStatus response code (text optional)
...... location ΣI0..1uriThe location (if the operation returns a location)
...... etag ΣI0..1stringThe Etag for the resource (if relevant)
...... lastModified ΣI0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature ΣI0..1SignatureDigital Signature

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Bundle.languagepreferredCommonLanguages
Max Binding: AllLanguages
Bundle.typerequiredFixed Value: document
Bundle.entry.search.moderequiredSearchEntryMode
Bundle.entry.request.methodrequiredHTTPVerb
Bundle.entry:gaps_composition_entry.search.moderequiredSearchEntryMode
Bundle.entry:gaps_composition_entry.request.methodrequiredHTTPVerb
Bundle.entry:gaps_indv_measure_report_entry.search.moderequiredSearchEntryMode
Bundle.entry:gaps_indv_measure_report_entry.request.methodrequiredHTTPVerb