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
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.
The following data-elements are mandatory (i.e data MUST be present).
Each Bundle Must Have:
Each Bundle Must Support:
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Bundle
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
gic-1 | error | Bundle.entry:gaps-composition-deqm | if '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-2 | error | Bundle.entry:gaps-composition-deqm | if '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' |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Bundle.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Bundle.type | required | BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
gic-1 | error | Bundle.entry:gaps-composition-deqm | if '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-2 | error | Bundle.entry:gaps-composition-deqm | if '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' |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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.
| |||||
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 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Bundle.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Bundle.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Bundle.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Bundle.type | required | BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard | ||||
Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard | ||||
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard | ||||
Bundle.entry:gaps-composition-deqm.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard | ||||
Bundle.entry:gaps-composition-deqm.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
gic-1 | error | Bundle.entry:gaps-composition-deqm | if '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-2 | error | Bundle.entry:gaps-composition-deqm | if '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' |
Differential View
This structure is derived from Bundle
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
gic-1 | error | Bundle.entry:gaps-composition-deqm | if '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-2 | error | Bundle.entry:gaps-composition-deqm | if '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
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Bundle.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Bundle.type | required | BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
gic-1 | error | Bundle.entry:gaps-composition-deqm | if '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-2 | error | Bundle.entry:gaps-composition-deqm | if '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
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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.
| |||||
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 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Bundle.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Bundle.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Bundle.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Bundle.type | required | BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard | ||||
Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard | ||||
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard | ||||
Bundle.entry:gaps-composition-deqm.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard | ||||
Bundle.entry:gaps-composition-deqm.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
gic-1 | error | Bundle.entry:gaps-composition-deqm | if '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-2 | error | Bundle.entry:gaps-composition-deqm | if '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' |
Other representations of profile: CSV, Excel, Schematron