CDC National Healthcare Safety Network (NHSN) Digital Quality Measures (dQM) Content Package IG
1.0.0 - Release 1
CDC National Healthcare Safety Network (NHSN) Digital Quality Measures (dQM) Content Package IG
1.0.0 - Release 1
This page is part of the CDC National Healthcare Safety Network (NHSN) Digital Quality Measures (dQM) Content Package IG (v1.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://www.cdc.gov/nhsn/fhirportal/dqm/ig/StructureDefinition/nhsn-subject-bundle | Version: 1.0.0 | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: NHSNSubjectBundle | ||
This profile defines a valid subject-specific dQM Bundle. The Bundle is comprised of entry slices representing a Patient, individual MeasureReports, and the underlying patient-centric clinical information.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type |
Description & Constraints Filter:  
|
|---|---|---|---|---|
  Bundle
|
C | 0..* | Bundle | A Bundle contains a collection of Resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bundle-no-modifier-extensions, bundle-all-measurereport-measure-contains-version |
  implicitRules
|
?!Σ | 0..1 | uri | A set of rules under which this content was created |
|
type
|
Σ | 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. |
  Slices for entry
|
ΣC | 2..* | BackboneElement |
An entry in the Bundle; will have a Resource or information Slice: Unordered, Open by profile:resource Constraints: bdl-5, bdl-8 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:individual-measurereport
|
ΣC | 1..* | BackboneElement | Individual Measure Report: each Individual MeasureReport refers to one Patient and one measure included in the Individual Measure Report List Constraints: bdl-5, bdl-8 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
|
1..1 | DEQMIndividualMeasureReportProfile | The Bundle entry for an Individual Measure Report | |
 entry:patient
|
ΣC | 1..1 | BackboneElement | The Patients associated with an Individual MeasureReport Constraints: bdl-5, bdl-8 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
|
1..1 | CrossMeasurePatient | The Bundle entry for a Patient associated with an Individual Measure Report | |
|
Documentation for this format
| ||||
| Path | Conformance | ValueSet | URI |
| Bundle.type | required |
BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') |
|
| bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') |
|
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) |
|
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')) |
|
| bdl-5 | error | Bundle.entry, Bundle.entry:individual-measurereport, Bundle.entry:patient | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() |
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() |
|
| bdl-8 | error | Bundle.entry, Bundle.entry:individual-measurereport, Bundle.entry:patient | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() |
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) |
|
| bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) |
|
| bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) |
|
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) |
|
| bundle-all-measurereport-measure-contains-version | error | Bundle | MeasureReport Bundle: All MeasureReport entry's measure Canonical must contain version : Bundle.entry.resource.where($this.is(MeasureReport)).all(measure.matches('(\\|)..*$')) |
|
| bundle-no-modifier-extensions | error | Bundle | MeasureReport Bundle: must not contain any modifierExensions : (descendants().select(modifierExtension)).exists().not() |
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Bundle
| Name | Flags | Card. | Type |
Description & Constraints Filter:
|
|---|---|---|---|---|
|
Bundle
|
C | 0..* | Bundle | A Bundle contains a collection of Resources Constraints: bundle-no-modifier-extensions, bundle-all-measurereport-measure-contains-version |
|
Slices for entry
|
2..* | BackboneElement |
An entry in the Bundle; will have a Resource or information Slice: Unordered, Open by profile:resource |
|
|
entry:individual-measurereport
|
1..* | BackboneElement | Individual Measure Report: each Individual MeasureReport refers to one Patient and one measure included in the Individual Measure Report List |
|
|
resource
|
1..1 | DEQMIndividualMeasureReportProfile | The Bundle entry for an Individual Measure Report | |
|
entry:patient
|
1..1 | BackboneElement | The Patients associated with an Individual MeasureReport | |
|
resource
|
1..1 | CrossMeasurePatient | The Bundle entry for a Patient associated with an Individual Measure Report | |
|
Documentation for this format
| ||||
| Id | Grade | Path(s) | Details | Requirements |
| bundle-all-measurereport-measure-contains-version | error | Bundle | MeasureReport Bundle: All MeasureReport entry's measure Canonical must contain version : Bundle.entry.resource.where($this.is(MeasureReport)).all(measure.matches('(\\|)..*$')) |
|
| bundle-no-modifier-extensions | error | Bundle | MeasureReport Bundle: must not contain any modifierExensions : (descendants().select(modifierExtension)).exists().not() |
| Name | Flags | Card. | Type |
Description & Constraints Filter:
|
||||
|---|---|---|---|---|---|---|---|---|
|
Bundle
|
C | 0..* | Bundle | A Bundle contains a collection of Resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bundle-no-modifier-extensions, bundle-all-measurereport-measure-contains-version |
||||
|
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
|
Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
|
type
|
Σ | 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
|
Σ | 0..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
|
ΣC | 2..* | BackboneElement |
An entry in the Bundle; will have a Resource or information Slice: Unordered, Open by profile:resource Constraints: bdl-5, bdl-8 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:individual-measurereport
|
ΣC | 1..* | BackboneElement | Individual Measure Report: each Individual MeasureReport refers to one Patient and one measure included in the Individual Measure Report List Constraints: bdl-5, bdl-8 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
|
1..1 | DEQMIndividualMeasureReportProfile | The Bundle entry for an Individual Measure Report | |||||
 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:patient
|
ΣC | 1..1 | BackboneElement | The Patients associated with an Individual MeasureReport Constraints: bdl-5, bdl-8 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
|
1..1 | CrossMeasurePatient | The Bundle entry for a Patient associated with an Individual Measure Report | |||||
|
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 |
CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1
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:individual-measurereport.search.mode | required |
SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
|
||||
| Bundle.entry:individual-measurereport.request.method | required |
HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
|
||||
| Bundle.entry:patient.search.mode | required |
SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
|
||||
| Bundle.entry:patient.request.method | required |
HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') |
|
| bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') |
|
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) |
|
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')) |
|
| bdl-5 | error | Bundle.entry, Bundle.entry:individual-measurereport, Bundle.entry:patient | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() |
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() |
|
| bdl-8 | error | Bundle.entry, Bundle.entry:individual-measurereport, Bundle.entry:patient | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() |
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) |
|
| bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) |
|
| bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) |
|
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) |
|
| bundle-all-measurereport-measure-contains-version | error | Bundle | MeasureReport Bundle: All MeasureReport entry's measure Canonical must contain version : Bundle.entry.resource.where($this.is(MeasureReport)).all(measure.matches('(\\|)..*$')) |
|
| bundle-no-modifier-extensions | error | Bundle | MeasureReport Bundle: must not contain any modifierExensions : (descendants().select(modifierExtension)).exists().not() |
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Bundle
Summary
Mandatory: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type |
Description & Constraints Filter:
|
|---|---|---|---|---|
|
Bundle
|
C | 0..* | Bundle | A Bundle contains a collection of Resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bundle-no-modifier-extensions, bundle-all-measurereport-measure-contains-version |
|
implicitRules
|
?!Σ | 0..1 | uri | A set of rules under which this content was created |
|
type
|
Σ | 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. |
|
Slices for entry
|
ΣC | 2..* | BackboneElement |
An entry in the Bundle; will have a Resource or information Slice: Unordered, Open by profile:resource Constraints: bdl-5, bdl-8 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:individual-measurereport
|
ΣC | 1..* | BackboneElement | Individual Measure Report: each Individual MeasureReport refers to one Patient and one measure included in the Individual Measure Report List Constraints: bdl-5, bdl-8 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
|
1..1 | DEQMIndividualMeasureReportProfile | The Bundle entry for an Individual Measure Report | |
|
entry:patient
|
ΣC | 1..1 | BackboneElement | The Patients associated with an Individual MeasureReport Constraints: bdl-5, bdl-8 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
|
1..1 | CrossMeasurePatient | The Bundle entry for a Patient associated with an Individual Measure Report | |
|
Documentation for this format
| ||||
| Path | Conformance | ValueSet | URI |
| Bundle.type | required |
BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') |
|
| bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') |
|
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) |
|
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')) |
|
| bdl-5 | error | Bundle.entry, Bundle.entry:individual-measurereport, Bundle.entry:patient | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() |
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() |
|
| bdl-8 | error | Bundle.entry, Bundle.entry:individual-measurereport, Bundle.entry:patient | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() |
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) |
|
| bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) |
|
| bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) |
|
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) |
|
| bundle-all-measurereport-measure-contains-version | error | Bundle | MeasureReport Bundle: All MeasureReport entry's measure Canonical must contain version : Bundle.entry.resource.where($this.is(MeasureReport)).all(measure.matches('(\\|)..*$')) |
|
| bundle-no-modifier-extensions | error | Bundle | MeasureReport Bundle: must not contain any modifierExensions : (descendants().select(modifierExtension)).exists().not() |
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Bundle
| Name | Flags | Card. | Type |
Description & Constraints Filter:
|
|---|---|---|---|---|
|
Bundle
|
C | 0..* | Bundle | A Bundle contains a collection of Resources Constraints: bundle-no-modifier-extensions, bundle-all-measurereport-measure-contains-version |
|
Slices for entry
|
2..* | BackboneElement |
An entry in the Bundle; will have a Resource or information Slice: Unordered, Open by profile:resource |
|
|
entry:individual-measurereport
|
1..* | BackboneElement | Individual Measure Report: each Individual MeasureReport refers to one Patient and one measure included in the Individual Measure Report List |
|
|
resource
|
1..1 | DEQMIndividualMeasureReportProfile | The Bundle entry for an Individual Measure Report | |
|
entry:patient
|
1..1 | BackboneElement | The Patients associated with an Individual MeasureReport | |
|
resource
|
1..1 | CrossMeasurePatient | The Bundle entry for a Patient associated with an Individual Measure Report | |
|
Documentation for this format
| ||||
| Id | Grade | Path(s) | Details | Requirements |
| bundle-all-measurereport-measure-contains-version | error | Bundle | MeasureReport Bundle: All MeasureReport entry's measure Canonical must contain version : Bundle.entry.resource.where($this.is(MeasureReport)).all(measure.matches('(\\|)..*$')) |
|
| bundle-no-modifier-extensions | error | Bundle | MeasureReport Bundle: must not contain any modifierExensions : (descendants().select(modifierExtension)).exists().not() |
Snapshot View
| Name | Flags | Card. | Type |
Description & Constraints Filter:
|
||||
|---|---|---|---|---|---|---|---|---|
|
Bundle
|
C | 0..* | Bundle | A Bundle contains a collection of Resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bundle-no-modifier-extensions, bundle-all-measurereport-measure-contains-version |
||||
|
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
|
Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
|
type
|
Σ | 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
|
Σ | 0..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
|
ΣC | 2..* | BackboneElement |
An entry in the Bundle; will have a Resource or information Slice: Unordered, Open by profile:resource Constraints: bdl-5, bdl-8 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:individual-measurereport
|
ΣC | 1..* | BackboneElement | Individual Measure Report: each Individual MeasureReport refers to one Patient and one measure included in the Individual Measure Report List Constraints: bdl-5, bdl-8 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
|
1..1 | DEQMIndividualMeasureReportProfile | The Bundle entry for an Individual Measure Report | |||||
|
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:patient
|
ΣC | 1..1 | BackboneElement | The Patients associated with an Individual MeasureReport Constraints: bdl-5, bdl-8 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
|
1..1 | CrossMeasurePatient | The Bundle entry for a Patient associated with an Individual Measure Report | |||||
|
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 |
CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1
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:individual-measurereport.search.mode | required |
SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
|
||||
| Bundle.entry:individual-measurereport.request.method | required |
HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
|
||||
| Bundle.entry:patient.search.mode | required |
SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
|
||||
| Bundle.entry:patient.request.method | required |
HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') |
|
| bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') |
|
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) |
|
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')) |
|
| bdl-5 | error | Bundle.entry, Bundle.entry:individual-measurereport, Bundle.entry:patient | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() |
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() |
|
| bdl-8 | error | Bundle.entry, Bundle.entry:individual-measurereport, Bundle.entry:patient | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() |
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) |
|
| bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) |
|
| bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) |
|
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) |
|
| bundle-all-measurereport-measure-contains-version | error | Bundle | MeasureReport Bundle: All MeasureReport entry's measure Canonical must contain version : Bundle.entry.resource.where($this.is(MeasureReport)).all(measure.matches('(\\|)..*$')) |
|
| bundle-no-modifier-extensions | error | Bundle | MeasureReport Bundle: must not contain any modifierExensions : (descendants().select(modifierExtension)).exists().not() |
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Bundle
Summary
Mandatory: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
