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

Data Exchange For Quality Measures Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 5.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-deqm/ and changes regularly. See the Directory of published versions

Resource Profile: DEQM Gaps In Care Bundle

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

The DEQM Gaps In Care Bundle 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.

Mandatory Data Elements and Terminology

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

Each Bundle Must Have:

  1. identifier: Persistent identifier for the bundle
  2. identifier.system: The namespace for the identifier value
  3. identifier.value: The value that is unique
  4. type: document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
  5. timestamp: When the bundle was assembled
  6. link.relation: See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
  7. link.url: Reference details for the link
  8. entry: Entry in the bundle - will have a resource or information
  9. entry.request.method: GET | HEAD | POST | PUT | DELETE | PATCH
  10. entry.request.url: URL for HTTP equivalent of this entry
  11. entry.response.status: Status response code (text optional)

Each Bundle Must Support:

  1. entry: Contains a composition of gaps in care report for an individual for one or more measures

This profile builds on Bundle.

Additional Profile specific implementation guidance:

Conformance Requirement 1:

The DEQM Gaps In Care Bundle SHALL include entries for all patient specific resources including evaluated resources referenced by the included DEQM Gaps In Care MeasureReport and for resources referenced by the DEQM Gaps In Care DetectedIssue including GuidanceResponse.

Usage:

Formal Views of Profile Content

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

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..* Bundle Contains a collection of resources
... identifier S 1..1 Identifier Persistent identifier for the bundle
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
... type S 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
... timestamp S 1..1 instant When the bundle was assembled
... Slices for entry S 1..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by type:resource
.... entry:gaps-composition-deqm SC 0..1 BackboneElement Contains a composition of gaps in care report for an individual for one or more measures
gic-1: if 'entry:gaps-composition-deqm' is present, then Bundle.type is 'document'
gic-2: if 'entry:gaps-composition-deqm' is not present, then Bundle.type is 'collection'
..... resource S 1..1 DEQMGapsInCareCompositionProfile This Composition uses the DEQM Gaps In Care Composition Profile

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
gic-1errorBundle.entry:gaps-composition-deqmif 'entry:gaps-composition-deqm' is present, then Bundle.type is 'document'
: resource.meta.profile.contains('http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/gaps-composition-deqm') implies %resource.type='document'
gic-2errorBundle.entry:gaps-composition-deqmif 'entry:gaps-composition-deqm' is not present, then Bundle.type is 'collection'
: resource.meta.profile.contains('http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/gaps-composition-deqm').not() implies %resource.type='collection'
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier SΣ 1..1 Identifier Persistent identifier for the bundle
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
... type SΣ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.

... timestamp SΣ 1..1 instant When the bundle was assembled
... Slices for entry SΣC 1..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by type:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entry:gaps-composition-deqm SΣC 0..1 BackboneElement Contains a composition of gaps in care report for an individual for one or more measures
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
gic-1: if 'entry:gaps-composition-deqm' is present, then Bundle.type is 'document'
gic-2: if 'entry:gaps-composition-deqm' is not present, then Bundle.type is 'collection'
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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource S 1..1 DEQMGapsInCareCompositionProfile This Composition uses the DEQM Gaps In Care Composition Profile

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Bundle.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Bundle.typerequiredBundleType
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
gic-1errorBundle.entry:gaps-composition-deqmif 'entry:gaps-composition-deqm' is present, then Bundle.type is 'document'
: resource.meta.profile.contains('http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/gaps-composition-deqm') implies %resource.type='document'
gic-2errorBundle.entry:gaps-composition-deqmif 'entry:gaps-composition-deqm' is not present, then Bundle.type is 'collection'
: resource.meta.profile.contains('http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/gaps-composition-deqm').not() implies %resource.type='collection'
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
... 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
... identifier SΣ 1..1 Identifier Persistent identifier for the bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... type SΣ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.

... timestamp SΣ 1..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link Σ 0..* BackboneElement Links related to this Bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... Slices for entry SΣC 1..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by type:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 0..1 Resource A resource in the bundle
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:gaps-composition-deqm SΣC 0..1 BackboneElement Contains a composition of gaps in care report for an individual for one or more measures
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
gic-1: if 'entry:gaps-composition-deqm' is present, then Bundle.type is 'document'
gic-2: if 'entry:gaps-composition-deqm' is not present, then Bundle.type is 'collection'
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 DEQMGapsInCareCompositionProfile This Composition uses the DEQM Gaps In Care Composition Profile
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
... signature Σ 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Bundle.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Bundle.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Bundle.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Bundle.typerequiredBundleType
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:gaps-composition-deqm.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:gaps-composition-deqm.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
gic-1errorBundle.entry:gaps-composition-deqmif 'entry:gaps-composition-deqm' is present, then Bundle.type is 'document'
: resource.meta.profile.contains('http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/gaps-composition-deqm') implies %resource.type='document'
gic-2errorBundle.entry:gaps-composition-deqmif 'entry:gaps-composition-deqm' is not present, then Bundle.type is 'collection'
: resource.meta.profile.contains('http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/gaps-composition-deqm').not() implies %resource.type='collection'

This structure is derived from Bundle

Summary

Mandatory: 5 elements(1 nested mandatory element)
Must-Support: 8 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Bundle.entry

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..* Bundle Contains a collection of resources
... identifier S 1..1 Identifier Persistent identifier for the bundle
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
... type S 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
... timestamp S 1..1 instant When the bundle was assembled
... Slices for entry S 1..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by type:resource
.... entry:gaps-composition-deqm SC 0..1 BackboneElement Contains a composition of gaps in care report for an individual for one or more measures
gic-1: if 'entry:gaps-composition-deqm' is present, then Bundle.type is 'document'
gic-2: if 'entry:gaps-composition-deqm' is not present, then Bundle.type is 'collection'
..... resource S 1..1 DEQMGapsInCareCompositionProfile This Composition uses the DEQM Gaps In Care Composition Profile

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
gic-1errorBundle.entry:gaps-composition-deqmif 'entry:gaps-composition-deqm' is present, then Bundle.type is 'document'
: resource.meta.profile.contains('http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/gaps-composition-deqm') implies %resource.type='document'
gic-2errorBundle.entry:gaps-composition-deqmif 'entry:gaps-composition-deqm' is not present, then Bundle.type is 'collection'
: resource.meta.profile.contains('http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/gaps-composition-deqm').not() implies %resource.type='collection'

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier SΣ 1..1 Identifier Persistent identifier for the bundle
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
... type SΣ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.

... timestamp SΣ 1..1 instant When the bundle was assembled
... Slices for entry SΣC 1..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by type:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entry:gaps-composition-deqm SΣC 0..1 BackboneElement Contains a composition of gaps in care report for an individual for one or more measures
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
gic-1: if 'entry:gaps-composition-deqm' is present, then Bundle.type is 'document'
gic-2: if 'entry:gaps-composition-deqm' is not present, then Bundle.type is 'collection'
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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource S 1..1 DEQMGapsInCareCompositionProfile This Composition uses the DEQM Gaps In Care Composition Profile

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Bundle.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Bundle.typerequiredBundleType
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
gic-1errorBundle.entry:gaps-composition-deqmif 'entry:gaps-composition-deqm' is present, then Bundle.type is 'document'
: resource.meta.profile.contains('http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/gaps-composition-deqm') implies %resource.type='document'
gic-2errorBundle.entry:gaps-composition-deqmif 'entry:gaps-composition-deqm' is not present, then Bundle.type is 'collection'
: resource.meta.profile.contains('http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/gaps-composition-deqm').not() implies %resource.type='collection'

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
... 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
... identifier SΣ 1..1 Identifier Persistent identifier for the bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... type SΣ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.

... timestamp SΣ 1..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link Σ 0..* BackboneElement Links related to this Bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... Slices for entry SΣC 1..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by type:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 0..1 Resource A resource in the bundle
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:gaps-composition-deqm SΣC 0..1 BackboneElement Contains a composition of gaps in care report for an individual for one or more measures
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
gic-1: if 'entry:gaps-composition-deqm' is present, then Bundle.type is 'document'
gic-2: if 'entry:gaps-composition-deqm' is not present, then Bundle.type is 'collection'
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 DEQMGapsInCareCompositionProfile This Composition uses the DEQM Gaps In Care Composition Profile
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
... signature Σ 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Bundle.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Bundle.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Bundle.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Bundle.typerequiredBundleType
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:gaps-composition-deqm.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:gaps-composition-deqm.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
gic-1errorBundle.entry:gaps-composition-deqmif 'entry:gaps-composition-deqm' is present, then Bundle.type is 'document'
: resource.meta.profile.contains('http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/gaps-composition-deqm') implies %resource.type='document'
gic-2errorBundle.entry:gaps-composition-deqmif 'entry:gaps-composition-deqm' is not present, then Bundle.type is 'collection'
: resource.meta.profile.contains('http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/gaps-composition-deqm').not() implies %resource.type='collection'

This structure is derived from Bundle

Summary

Mandatory: 5 elements(1 nested mandatory element)
Must-Support: 8 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Bundle.entry

 

Other representations of profile: CSV, Excel, Schematron