CDC National Healthcare Safety Network (NHSN) Digital Quality Measures (dQM) Content Package IG
3.0.0 - Release 3 - draft United States of America flag

CDC National Healthcare Safety Network (NHSN) Digital Quality Measures (dQM) Content Package IG - Local Development build (v3.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: NHSN Submission Header Bundle

Official URL: http://www.cdc.gov/nhsn/fhirportal/dqm/ig/StructureDefinition/nhsn-submission-header-bundle Version: 3.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: NHSNSubmissionHeaderBundle
Other Identifiers: OID:2.16.840.1.113883.4.642.40.1002.42.45

This profile defines a valid Submission Header 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

Changes since version 1.0.0:

  • New Content
  • Formal Views of Profile Content

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

    Name Flags Card. Type Description & Constraints    Filter: doco
    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
    Bundle.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Bundle.type This element must be supported. This element is included in summaries. 1..1 code
    (NHSN-MS)
    The type of a Bundle is MeasureReport Submission Bundle that is of type `collection`
    Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
    Bundle.Slices for entry This element must be supported. This element is included in summaries. C 3..* BackboneElement
    (NHSN-MS)
    An entry in the Bundle; will have a Resource

    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
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
    Bundle.Slices for entry.entry:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-organization This element must be supported. This element is included in summaries. C 1..1 BackboneElement
    (NHSN-MS)
    The Submitting Organization: the organization that is the source of the data
    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
    Bundle.Slices for entry.entry:submitting-organization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-organization.fullUrl This element must be supported. This element is included in summaries. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Individual Measure Report Resource
    Bundle.Slices for entry.entry:submitting-organization.resource This element must be supported. 1..1 NHSNSubmittingOrganization Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well
    (NHSN-MS)
    Bundle entry for submitting organization
    Bundle.Slices for entry.entry:submitting-device This element must be supported. This element is included in summaries. C 1..1 BackboneElement
    (NHSN-MS)
    The Submitting Device: the device or software that is submitting the data
    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
    Bundle.Slices for entry.entry:submitting-device.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-device.fullUrl This element must be supported. This element is included in summaries. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Individual Measure Report Resource
    Bundle.Slices for entry.entry:submitting-device.resource This element must be supported. 1..1 NHSNSubmittingDevice Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well
    (NHSN-MS)
    Bundle entry for submitting device
    Bundle.Slices for entry.entry:poi-list This element must be supported. This element is included in summaries. C 0..1 BackboneElement
    (NHSN-MS)
    The Patients of Interest List: a List containing Patient FHIR IDs that may be included in the Initial Population across all measures
    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
    Bundle.Slices for entry.entry:poi-list.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:poi-list.fullUrl This element must be supported. This element is included in summaries. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Patients of Interest List Resource
    Bundle.Slices for entry.entry:poi-list.resource This element must be supported. 1..1 PatientsOfInterestList Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well
    (NHSN-MS)
    The Bundle entry for Patients of Interest List
    Bundle.Slices for entry.entry:subjectlist-measurereport This element must be supported. This element is included in summaries. C 1..* BackboneElement
    (NHSN-MS)
    Summary Measure Report: For each measure, there is one Summary MeasureReport. The Summary MeasureReport includes the population count and a link to the List of Individual MeasureReports that are included in the summary
    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
    Bundle.Slices for entry.entry:subjectlist-measurereport.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:subjectlist-measurereport.fullUrl This element must be supported. This element is included in summaries. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Summary Measure Report Resource
    Bundle.Slices for entry.entry:subjectlist-measurereport.resource This element must be supported. 1..1 SubjectListMeasureReportProfile Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well
    (NHSN-MS)
    The Bundle entry for a Summary Measure Report

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Bundle.type Base required BundleType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    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:submitting-organization, Bundle.entry:submitting-device, Bundle.entry:poi-list, Bundle.entry:subjectlist-measurereport 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:submitting-organization, Bundle.entry:submitting-device, Bundle.entry:poi-list, Bundle.entry:subjectlist-measurereport 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: doco
    Bundle C 0..* Bundle A Bundle contains a collection of Resources
    Constraints: bundle-no-modifier-extensions, bundle-all-measurereport-measure-contains-version
    Bundle.type This element must be supported. 1..1 code
    (NHSN-MS)
    The type of a Bundle is MeasureReport Submission Bundle that is of type `collection`
    Bundle.Slices for entry This element must be supported. 3..* BackboneElement
    (NHSN-MS)
    An entry in the Bundle; will have a Resource

    Slice: Unordered, Open by profile:resource
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Bundle.Slices for entry.entry:submitting-organization This element must be supported. 1..1 BackboneElement
    (NHSN-MS)
    The Submitting Organization: the organization that is the source of the data
    Bundle.Slices for entry.entry:submitting-organization.fullUrl This element must be supported. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Individual Measure Report Resource
    Bundle.Slices for entry.entry:submitting-organization.resource This element must be supported. 1..1 NHSNSubmittingOrganization
    (NHSN-MS)
    Bundle entry for submitting organization
    Bundle.Slices for entry.entry:submitting-device This element must be supported. 1..1 BackboneElement
    (NHSN-MS)
    The Submitting Device: the device or software that is submitting the data
    Bundle.Slices for entry.entry:submitting-device.fullUrl This element must be supported. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Individual Measure Report Resource
    Bundle.Slices for entry.entry:submitting-device.resource This element must be supported. 1..1 NHSNSubmittingDevice
    (NHSN-MS)
    Bundle entry for submitting device
    Bundle.Slices for entry.entry:poi-list This element must be supported. 0..1 BackboneElement
    (NHSN-MS)
    The Patients of Interest List: a List containing Patient FHIR IDs that may be included in the Initial Population across all measures
    Bundle.Slices for entry.entry:poi-list.fullUrl This element must be supported. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Patients of Interest List Resource
    Bundle.Slices for entry.entry:poi-list.resource This element must be supported. 1..1 PatientsOfInterestList
    (NHSN-MS)
    The Bundle entry for Patients of Interest List
    Bundle.Slices for entry.entry:subjectlist-measurereport This element must be supported. 1..* BackboneElement
    (NHSN-MS)
    Summary Measure Report: For each measure, there is one Summary MeasureReport. The Summary MeasureReport includes the population count and a link to the List of Individual MeasureReports that are included in the summary
    Bundle.Slices for entry.entry:subjectlist-measurereport.fullUrl This element must be supported. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Summary Measure Report Resource
    Bundle.Slices for entry.entry:subjectlist-measurereport.resource This element must be supported. 1..1 SubjectListMeasureReportProfile
    (NHSN-MS)
    The Bundle entry for a Summary Measure Report

    doco Documentation for this format

    Constraints

    Id Grade Path(s) Description Expression
    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: doco
    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
    Bundle.id This element is included in summaries. 0..1 id Logical id of this artifact
    Bundle.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Bundle.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Bundle.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional Bindings Purpose
    AllLanguages Max Binding
    Bundle.identifier This element is included in summaries. 0..1 Identifier Persistent identifier for the bundle
    Bundle.type This element must be supported. This element is included in summaries. 1..1 code
    (NHSN-MS)
    The type of a Bundle is MeasureReport Submission Bundle that is of type `collection`
    Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
    Bundle.timestamp This element is included in summaries. 0..1 instant When the bundle was assembled
    Bundle.total This element is included in summaries. C 0..1 unsignedInt If search, the total number of matches
    Bundle.link This element is included in summaries. 0..* BackboneElement Links related to this Bundle
    Bundle.link.id 0..1 string Unique id for inter-element referencing
    Bundle.link.extension 0..* Extension Additional content defined by implementations
    Bundle.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.link.relation This element is included in summaries. 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
    Bundle.link.url This element is included in summaries. 1..1 uri Reference details for the link
    Bundle.Slices for entry This element must be supported. This element is included in summaries. C 3..* BackboneElement
    (NHSN-MS)
    An entry in the Bundle; will have a Resource

    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
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
    Bundle.Slices for entry.entry:All Slices.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:All Slices.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:All Slices.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
    Bundle.Slices for entry.entry:All Slices.fullUrl This element is included in summaries. 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
    Bundle.Slices for entry.entry:All Slices.resource This element is included in summaries. 0..1 Resource A resource in the bundle
    Bundle.Slices for entry.entry:All Slices.search This element is included in summaries. C 0..1 BackboneElement Search related information
    Bundle.Slices for entry.entry:All Slices.search.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:All Slices.search.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:All Slices.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:All Slices.search.mode This element is included in summaries. 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.
    Bundle.Slices for entry.entry:All Slices.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
    Bundle.Slices for entry.entry:All Slices.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
    Bundle.Slices for entry.entry:All Slices.request.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:All Slices.request.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:All Slices.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:All Slices.request.method This element is included in summaries. 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
    Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
    Bundle.Slices for entry.entry:All Slices.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
    Bundle.Slices for entry.entry:All Slices.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
    Bundle.Slices for entry.entry:All Slices.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
    Bundle.Slices for entry.entry:All Slices.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
    Bundle.Slices for entry.entry:All Slices.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
    Bundle.Slices for entry.entry:All Slices.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
    Bundle.Slices for entry.entry:All Slices.response.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:All Slices.response.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:All Slices.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:All Slices.response.status This element is included in summaries. 1..1 string Status response code (text optional)
    Bundle.Slices for entry.entry:All Slices.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
    Bundle.Slices for entry.entry:All Slices.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
    Bundle.Slices for entry.entry:All Slices.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
    Bundle.Slices for entry.entry:All Slices.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
    Bundle.Slices for entry.entry:submitting-organization This element must be supported. This element is included in summaries. C 1..1 BackboneElement
    (NHSN-MS)
    The Submitting Organization: the organization that is the source of the data
    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
    Bundle.Slices for entry.entry:submitting-organization.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:submitting-organization.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:submitting-organization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-organization.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
    Bundle.Slices for entry.entry:submitting-organization.fullUrl This element must be supported. This element is included in summaries. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Individual Measure Report Resource
    Bundle.Slices for entry.entry:submitting-organization.resource This element must be supported. 1..1 NHSNSubmittingOrganization Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well
    (NHSN-MS)
    Bundle entry for submitting organization
    Bundle.Slices for entry.entry:submitting-organization.search This element is included in summaries. C 0..1 BackboneElement Search related information
    Bundle.Slices for entry.entry:submitting-organization.search.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:submitting-organization.search.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:submitting-organization.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-organization.search.mode This element is included in summaries. 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.
    Bundle.Slices for entry.entry:submitting-organization.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
    Bundle.Slices for entry.entry:submitting-organization.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
    Bundle.Slices for entry.entry:submitting-organization.request.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:submitting-organization.request.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:submitting-organization.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-organization.request.method This element is included in summaries. 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
    Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
    Bundle.Slices for entry.entry:submitting-organization.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
    Bundle.Slices for entry.entry:submitting-organization.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
    Bundle.Slices for entry.entry:submitting-organization.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
    Bundle.Slices for entry.entry:submitting-organization.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
    Bundle.Slices for entry.entry:submitting-organization.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
    Bundle.Slices for entry.entry:submitting-organization.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
    Bundle.Slices for entry.entry:submitting-organization.response.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:submitting-organization.response.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:submitting-organization.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-organization.response.status This element is included in summaries. 1..1 string Status response code (text optional)
    Bundle.Slices for entry.entry:submitting-organization.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
    Bundle.Slices for entry.entry:submitting-organization.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
    Bundle.Slices for entry.entry:submitting-organization.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
    Bundle.Slices for entry.entry:submitting-organization.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
    Bundle.Slices for entry.entry:submitting-device This element must be supported. This element is included in summaries. C 1..1 BackboneElement
    (NHSN-MS)
    The Submitting Device: the device or software that is submitting the data
    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
    Bundle.Slices for entry.entry:submitting-device.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:submitting-device.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:submitting-device.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-device.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
    Bundle.Slices for entry.entry:submitting-device.fullUrl This element must be supported. This element is included in summaries. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Individual Measure Report Resource
    Bundle.Slices for entry.entry:submitting-device.resource This element must be supported. 1..1 NHSNSubmittingDevice Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well
    (NHSN-MS)
    Bundle entry for submitting device
    Bundle.Slices for entry.entry:submitting-device.search This element is included in summaries. C 0..1 BackboneElement Search related information
    Bundle.Slices for entry.entry:submitting-device.search.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:submitting-device.search.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:submitting-device.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-device.search.mode This element is included in summaries. 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.
    Bundle.Slices for entry.entry:submitting-device.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
    Bundle.Slices for entry.entry:submitting-device.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
    Bundle.Slices for entry.entry:submitting-device.request.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:submitting-device.request.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:submitting-device.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-device.request.method This element is included in summaries. 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
    Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
    Bundle.Slices for entry.entry:submitting-device.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
    Bundle.Slices for entry.entry:submitting-device.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
    Bundle.Slices for entry.entry:submitting-device.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
    Bundle.Slices for entry.entry:submitting-device.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
    Bundle.Slices for entry.entry:submitting-device.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
    Bundle.Slices for entry.entry:submitting-device.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
    Bundle.Slices for entry.entry:submitting-device.response.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:submitting-device.response.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:submitting-device.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-device.response.status This element is included in summaries. 1..1 string Status response code (text optional)
    Bundle.Slices for entry.entry:submitting-device.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
    Bundle.Slices for entry.entry:submitting-device.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
    Bundle.Slices for entry.entry:submitting-device.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
    Bundle.Slices for entry.entry:submitting-device.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
    Bundle.Slices for entry.entry:poi-list This element must be supported. This element is included in summaries. C 0..1 BackboneElement
    (NHSN-MS)
    The Patients of Interest List: a List containing Patient FHIR IDs that may be included in the Initial Population across all measures
    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
    Bundle.Slices for entry.entry:poi-list.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:poi-list.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:poi-list.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:poi-list.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
    Bundle.Slices for entry.entry:poi-list.fullUrl This element must be supported. This element is included in summaries. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Patients of Interest List Resource
    Bundle.Slices for entry.entry:poi-list.resource This element must be supported. 1..1 PatientsOfInterestList Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well
    (NHSN-MS)
    The Bundle entry for Patients of Interest List
    Bundle.Slices for entry.entry:poi-list.search This element is included in summaries. C 0..1 BackboneElement Search related information
    Bundle.Slices for entry.entry:poi-list.search.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:poi-list.search.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:poi-list.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:poi-list.search.mode This element is included in summaries. 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.
    Bundle.Slices for entry.entry:poi-list.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
    Bundle.Slices for entry.entry:poi-list.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
    Bundle.Slices for entry.entry:poi-list.request.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:poi-list.request.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:poi-list.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:poi-list.request.method This element is included in summaries. 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
    Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
    Bundle.Slices for entry.entry:poi-list.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
    Bundle.Slices for entry.entry:poi-list.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
    Bundle.Slices for entry.entry:poi-list.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
    Bundle.Slices for entry.entry:poi-list.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
    Bundle.Slices for entry.entry:poi-list.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
    Bundle.Slices for entry.entry:poi-list.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
    Bundle.Slices for entry.entry:poi-list.response.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:poi-list.response.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:poi-list.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:poi-list.response.status This element is included in summaries. 1..1 string Status response code (text optional)
    Bundle.Slices for entry.entry:poi-list.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
    Bundle.Slices for entry.entry:poi-list.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
    Bundle.Slices for entry.entry:poi-list.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
    Bundle.Slices for entry.entry:poi-list.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
    Bundle.Slices for entry.entry:subjectlist-measurereport This element must be supported. This element is included in summaries. C 1..* BackboneElement
    (NHSN-MS)
    Summary Measure Report: For each measure, there is one Summary MeasureReport. The Summary MeasureReport includes the population count and a link to the List of Individual MeasureReports that are included in the summary
    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
    Bundle.Slices for entry.entry:subjectlist-measurereport.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:subjectlist-measurereport.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:subjectlist-measurereport.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:subjectlist-measurereport.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
    Bundle.Slices for entry.entry:subjectlist-measurereport.fullUrl This element must be supported. This element is included in summaries. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Summary Measure Report Resource
    Bundle.Slices for entry.entry:subjectlist-measurereport.resource This element must be supported. 1..1 SubjectListMeasureReportProfile Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well
    (NHSN-MS)
    The Bundle entry for a Summary Measure Report
    Bundle.Slices for entry.entry:subjectlist-measurereport.search This element is included in summaries. C 0..1 BackboneElement Search related information
    Bundle.Slices for entry.entry:subjectlist-measurereport.search.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:subjectlist-measurereport.search.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:subjectlist-measurereport.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:subjectlist-measurereport.search.mode This element is included in summaries. 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.
    Bundle.Slices for entry.entry:subjectlist-measurereport.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
    Bundle.Slices for entry.entry:subjectlist-measurereport.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
    Bundle.Slices for entry.entry:subjectlist-measurereport.request.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:subjectlist-measurereport.request.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:subjectlist-measurereport.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:subjectlist-measurereport.request.method This element is included in summaries. 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
    Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
    Bundle.Slices for entry.entry:subjectlist-measurereport.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
    Bundle.Slices for entry.entry:subjectlist-measurereport.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
    Bundle.Slices for entry.entry:subjectlist-measurereport.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
    Bundle.Slices for entry.entry:subjectlist-measurereport.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
    Bundle.Slices for entry.entry:subjectlist-measurereport.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
    Bundle.Slices for entry.entry:subjectlist-measurereport.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
    Bundle.Slices for entry.entry:subjectlist-measurereport.response.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:subjectlist-measurereport.response.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:subjectlist-measurereport.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:subjectlist-measurereport.response.status This element is included in summaries. 1..1 string Status response code (text optional)
    Bundle.Slices for entry.entry:subjectlist-measurereport.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
    Bundle.Slices for entry.entry:subjectlist-measurereport.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
    Bundle.Slices for entry.entry:subjectlist-measurereport.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
    Bundle.Slices for entry.entry:subjectlist-measurereport.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
    Bundle.signature This element is included in summaries. 0..1 Signature Digital Signature

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Bundle.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Bundle.type Base required BundleType 📍4.0.1 FHIR Std.
    Bundle.entry.search.​mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:submitting-organization.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:submitting-organization.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:submitting-device.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:submitting-device.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:poi-list.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:poi-list.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:subjectlist-measurereport.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:subjectlist-measurereport.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    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:submitting-organization, Bundle.entry:submitting-device, Bundle.entry:poi-list, Bundle.entry:subjectlist-measurereport 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:submitting-organization, Bundle.entry:submitting-device, Bundle.entry:poi-list, Bundle.entry:subjectlist-measurereport 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()

    Key Elements View

    Name Flags Card. Type Description & Constraints    Filter: doco
    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
    Bundle.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Bundle.type This element must be supported. This element is included in summaries. 1..1 code
    (NHSN-MS)
    The type of a Bundle is MeasureReport Submission Bundle that is of type `collection`
    Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
    Bundle.Slices for entry This element must be supported. This element is included in summaries. C 3..* BackboneElement
    (NHSN-MS)
    An entry in the Bundle; will have a Resource

    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
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
    Bundle.Slices for entry.entry:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-organization This element must be supported. This element is included in summaries. C 1..1 BackboneElement
    (NHSN-MS)
    The Submitting Organization: the organization that is the source of the data
    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
    Bundle.Slices for entry.entry:submitting-organization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-organization.fullUrl This element must be supported. This element is included in summaries. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Individual Measure Report Resource
    Bundle.Slices for entry.entry:submitting-organization.resource This element must be supported. 1..1 NHSNSubmittingOrganization Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well
    (NHSN-MS)
    Bundle entry for submitting organization
    Bundle.Slices for entry.entry:submitting-device This element must be supported. This element is included in summaries. C 1..1 BackboneElement
    (NHSN-MS)
    The Submitting Device: the device or software that is submitting the data
    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
    Bundle.Slices for entry.entry:submitting-device.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-device.fullUrl This element must be supported. This element is included in summaries. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Individual Measure Report Resource
    Bundle.Slices for entry.entry:submitting-device.resource This element must be supported. 1..1 NHSNSubmittingDevice Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well
    (NHSN-MS)
    Bundle entry for submitting device
    Bundle.Slices for entry.entry:poi-list This element must be supported. This element is included in summaries. C 0..1 BackboneElement
    (NHSN-MS)
    The Patients of Interest List: a List containing Patient FHIR IDs that may be included in the Initial Population across all measures
    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
    Bundle.Slices for entry.entry:poi-list.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:poi-list.fullUrl This element must be supported. This element is included in summaries. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Patients of Interest List Resource
    Bundle.Slices for entry.entry:poi-list.resource This element must be supported. 1..1 PatientsOfInterestList Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well
    (NHSN-MS)
    The Bundle entry for Patients of Interest List
    Bundle.Slices for entry.entry:subjectlist-measurereport This element must be supported. This element is included in summaries. C 1..* BackboneElement
    (NHSN-MS)
    Summary Measure Report: For each measure, there is one Summary MeasureReport. The Summary MeasureReport includes the population count and a link to the List of Individual MeasureReports that are included in the summary
    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
    Bundle.Slices for entry.entry:subjectlist-measurereport.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:subjectlist-measurereport.fullUrl This element must be supported. This element is included in summaries. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Summary Measure Report Resource
    Bundle.Slices for entry.entry:subjectlist-measurereport.resource This element must be supported. 1..1 SubjectListMeasureReportProfile Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well
    (NHSN-MS)
    The Bundle entry for a Summary Measure Report

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Bundle.type Base required BundleType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    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:submitting-organization, Bundle.entry:submitting-device, Bundle.entry:poi-list, Bundle.entry:subjectlist-measurereport 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:submitting-organization, Bundle.entry:submitting-device, Bundle.entry:poi-list, Bundle.entry:subjectlist-measurereport 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: doco
    Bundle C 0..* Bundle A Bundle contains a collection of Resources
    Constraints: bundle-no-modifier-extensions, bundle-all-measurereport-measure-contains-version
    Bundle.type This element must be supported. 1..1 code
    (NHSN-MS)
    The type of a Bundle is MeasureReport Submission Bundle that is of type `collection`
    Bundle.Slices for entry This element must be supported. 3..* BackboneElement
    (NHSN-MS)
    An entry in the Bundle; will have a Resource

    Slice: Unordered, Open by profile:resource
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Bundle.Slices for entry.entry:submitting-organization This element must be supported. 1..1 BackboneElement
    (NHSN-MS)
    The Submitting Organization: the organization that is the source of the data
    Bundle.Slices for entry.entry:submitting-organization.fullUrl This element must be supported. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Individual Measure Report Resource
    Bundle.Slices for entry.entry:submitting-organization.resource This element must be supported. 1..1 NHSNSubmittingOrganization
    (NHSN-MS)
    Bundle entry for submitting organization
    Bundle.Slices for entry.entry:submitting-device This element must be supported. 1..1 BackboneElement
    (NHSN-MS)
    The Submitting Device: the device or software that is submitting the data
    Bundle.Slices for entry.entry:submitting-device.fullUrl This element must be supported. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Individual Measure Report Resource
    Bundle.Slices for entry.entry:submitting-device.resource This element must be supported. 1..1 NHSNSubmittingDevice
    (NHSN-MS)
    Bundle entry for submitting device
    Bundle.Slices for entry.entry:poi-list This element must be supported. 0..1 BackboneElement
    (NHSN-MS)
    The Patients of Interest List: a List containing Patient FHIR IDs that may be included in the Initial Population across all measures
    Bundle.Slices for entry.entry:poi-list.fullUrl This element must be supported. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Patients of Interest List Resource
    Bundle.Slices for entry.entry:poi-list.resource This element must be supported. 1..1 PatientsOfInterestList
    (NHSN-MS)
    The Bundle entry for Patients of Interest List
    Bundle.Slices for entry.entry:subjectlist-measurereport This element must be supported. 1..* BackboneElement
    (NHSN-MS)
    Summary Measure Report: For each measure, there is one Summary MeasureReport. The Summary MeasureReport includes the population count and a link to the List of Individual MeasureReports that are included in the summary
    Bundle.Slices for entry.entry:subjectlist-measurereport.fullUrl This element must be supported. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Summary Measure Report Resource
    Bundle.Slices for entry.entry:subjectlist-measurereport.resource This element must be supported. 1..1 SubjectListMeasureReportProfile
    (NHSN-MS)
    The Bundle entry for a Summary Measure Report

    doco Documentation for this format

    Constraints

    Id Grade Path(s) Description Expression
    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: doco
    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
    Bundle.id This element is included in summaries. 0..1 id Logical id of this artifact
    Bundle.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Bundle.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Bundle.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional Bindings Purpose
    AllLanguages Max Binding
    Bundle.identifier This element is included in summaries. 0..1 Identifier Persistent identifier for the bundle
    Bundle.type This element must be supported. This element is included in summaries. 1..1 code
    (NHSN-MS)
    The type of a Bundle is MeasureReport Submission Bundle that is of type `collection`
    Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
    Bundle.timestamp This element is included in summaries. 0..1 instant When the bundle was assembled
    Bundle.total This element is included in summaries. C 0..1 unsignedInt If search, the total number of matches
    Bundle.link This element is included in summaries. 0..* BackboneElement Links related to this Bundle
    Bundle.link.id 0..1 string Unique id for inter-element referencing
    Bundle.link.extension 0..* Extension Additional content defined by implementations
    Bundle.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.link.relation This element is included in summaries. 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
    Bundle.link.url This element is included in summaries. 1..1 uri Reference details for the link
    Bundle.Slices for entry This element must be supported. This element is included in summaries. C 3..* BackboneElement
    (NHSN-MS)
    An entry in the Bundle; will have a Resource

    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
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Bundle.Slices for entry.entry:All Slices Content/Rules for all slices
    Bundle.Slices for entry.entry:All Slices.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:All Slices.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:All Slices.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
    Bundle.Slices for entry.entry:All Slices.fullUrl This element is included in summaries. 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
    Bundle.Slices for entry.entry:All Slices.resource This element is included in summaries. 0..1 Resource A resource in the bundle
    Bundle.Slices for entry.entry:All Slices.search This element is included in summaries. C 0..1 BackboneElement Search related information
    Bundle.Slices for entry.entry:All Slices.search.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:All Slices.search.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:All Slices.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:All Slices.search.mode This element is included in summaries. 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.
    Bundle.Slices for entry.entry:All Slices.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
    Bundle.Slices for entry.entry:All Slices.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
    Bundle.Slices for entry.entry:All Slices.request.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:All Slices.request.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:All Slices.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:All Slices.request.method This element is included in summaries. 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
    Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
    Bundle.Slices for entry.entry:All Slices.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
    Bundle.Slices for entry.entry:All Slices.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
    Bundle.Slices for entry.entry:All Slices.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
    Bundle.Slices for entry.entry:All Slices.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
    Bundle.Slices for entry.entry:All Slices.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
    Bundle.Slices for entry.entry:All Slices.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
    Bundle.Slices for entry.entry:All Slices.response.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:All Slices.response.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:All Slices.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:All Slices.response.status This element is included in summaries. 1..1 string Status response code (text optional)
    Bundle.Slices for entry.entry:All Slices.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
    Bundle.Slices for entry.entry:All Slices.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
    Bundle.Slices for entry.entry:All Slices.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
    Bundle.Slices for entry.entry:All Slices.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
    Bundle.Slices for entry.entry:submitting-organization This element must be supported. This element is included in summaries. C 1..1 BackboneElement
    (NHSN-MS)
    The Submitting Organization: the organization that is the source of the data
    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
    Bundle.Slices for entry.entry:submitting-organization.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:submitting-organization.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:submitting-organization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-organization.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
    Bundle.Slices for entry.entry:submitting-organization.fullUrl This element must be supported. This element is included in summaries. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Individual Measure Report Resource
    Bundle.Slices for entry.entry:submitting-organization.resource This element must be supported. 1..1 NHSNSubmittingOrganization Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well
    (NHSN-MS)
    Bundle entry for submitting organization
    Bundle.Slices for entry.entry:submitting-organization.search This element is included in summaries. C 0..1 BackboneElement Search related information
    Bundle.Slices for entry.entry:submitting-organization.search.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:submitting-organization.search.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:submitting-organization.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-organization.search.mode This element is included in summaries. 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.
    Bundle.Slices for entry.entry:submitting-organization.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
    Bundle.Slices for entry.entry:submitting-organization.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
    Bundle.Slices for entry.entry:submitting-organization.request.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:submitting-organization.request.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:submitting-organization.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-organization.request.method This element is included in summaries. 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
    Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
    Bundle.Slices for entry.entry:submitting-organization.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
    Bundle.Slices for entry.entry:submitting-organization.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
    Bundle.Slices for entry.entry:submitting-organization.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
    Bundle.Slices for entry.entry:submitting-organization.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
    Bundle.Slices for entry.entry:submitting-organization.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
    Bundle.Slices for entry.entry:submitting-organization.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
    Bundle.Slices for entry.entry:submitting-organization.response.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:submitting-organization.response.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:submitting-organization.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-organization.response.status This element is included in summaries. 1..1 string Status response code (text optional)
    Bundle.Slices for entry.entry:submitting-organization.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
    Bundle.Slices for entry.entry:submitting-organization.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
    Bundle.Slices for entry.entry:submitting-organization.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
    Bundle.Slices for entry.entry:submitting-organization.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
    Bundle.Slices for entry.entry:submitting-device This element must be supported. This element is included in summaries. C 1..1 BackboneElement
    (NHSN-MS)
    The Submitting Device: the device or software that is submitting the data
    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
    Bundle.Slices for entry.entry:submitting-device.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:submitting-device.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:submitting-device.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-device.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
    Bundle.Slices for entry.entry:submitting-device.fullUrl This element must be supported. This element is included in summaries. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Individual Measure Report Resource
    Bundle.Slices for entry.entry:submitting-device.resource This element must be supported. 1..1 NHSNSubmittingDevice Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well
    (NHSN-MS)
    Bundle entry for submitting device
    Bundle.Slices for entry.entry:submitting-device.search This element is included in summaries. C 0..1 BackboneElement Search related information
    Bundle.Slices for entry.entry:submitting-device.search.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:submitting-device.search.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:submitting-device.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-device.search.mode This element is included in summaries. 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.
    Bundle.Slices for entry.entry:submitting-device.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
    Bundle.Slices for entry.entry:submitting-device.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
    Bundle.Slices for entry.entry:submitting-device.request.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:submitting-device.request.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:submitting-device.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-device.request.method This element is included in summaries. 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
    Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
    Bundle.Slices for entry.entry:submitting-device.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
    Bundle.Slices for entry.entry:submitting-device.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
    Bundle.Slices for entry.entry:submitting-device.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
    Bundle.Slices for entry.entry:submitting-device.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
    Bundle.Slices for entry.entry:submitting-device.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
    Bundle.Slices for entry.entry:submitting-device.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
    Bundle.Slices for entry.entry:submitting-device.response.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:submitting-device.response.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:submitting-device.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:submitting-device.response.status This element is included in summaries. 1..1 string Status response code (text optional)
    Bundle.Slices for entry.entry:submitting-device.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
    Bundle.Slices for entry.entry:submitting-device.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
    Bundle.Slices for entry.entry:submitting-device.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
    Bundle.Slices for entry.entry:submitting-device.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
    Bundle.Slices for entry.entry:poi-list This element must be supported. This element is included in summaries. C 0..1 BackboneElement
    (NHSN-MS)
    The Patients of Interest List: a List containing Patient FHIR IDs that may be included in the Initial Population across all measures
    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
    Bundle.Slices for entry.entry:poi-list.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:poi-list.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:poi-list.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:poi-list.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
    Bundle.Slices for entry.entry:poi-list.fullUrl This element must be supported. This element is included in summaries. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Patients of Interest List Resource
    Bundle.Slices for entry.entry:poi-list.resource This element must be supported. 1..1 PatientsOfInterestList Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well
    (NHSN-MS)
    The Bundle entry for Patients of Interest List
    Bundle.Slices for entry.entry:poi-list.search This element is included in summaries. C 0..1 BackboneElement Search related information
    Bundle.Slices for entry.entry:poi-list.search.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:poi-list.search.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:poi-list.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:poi-list.search.mode This element is included in summaries. 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.
    Bundle.Slices for entry.entry:poi-list.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
    Bundle.Slices for entry.entry:poi-list.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
    Bundle.Slices for entry.entry:poi-list.request.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:poi-list.request.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:poi-list.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:poi-list.request.method This element is included in summaries. 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
    Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
    Bundle.Slices for entry.entry:poi-list.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
    Bundle.Slices for entry.entry:poi-list.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
    Bundle.Slices for entry.entry:poi-list.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
    Bundle.Slices for entry.entry:poi-list.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
    Bundle.Slices for entry.entry:poi-list.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
    Bundle.Slices for entry.entry:poi-list.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
    Bundle.Slices for entry.entry:poi-list.response.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:poi-list.response.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:poi-list.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:poi-list.response.status This element is included in summaries. 1..1 string Status response code (text optional)
    Bundle.Slices for entry.entry:poi-list.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
    Bundle.Slices for entry.entry:poi-list.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
    Bundle.Slices for entry.entry:poi-list.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
    Bundle.Slices for entry.entry:poi-list.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
    Bundle.Slices for entry.entry:subjectlist-measurereport This element must be supported. This element is included in summaries. C 1..* BackboneElement
    (NHSN-MS)
    Summary Measure Report: For each measure, there is one Summary MeasureReport. The Summary MeasureReport includes the population count and a link to the List of Individual MeasureReports that are included in the summary
    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
    Bundle.Slices for entry.entry:subjectlist-measurereport.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:subjectlist-measurereport.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:subjectlist-measurereport.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:subjectlist-measurereport.link This element is included in summaries. 0..* See link (Bundle) Links related to this entry
    Bundle.Slices for entry.entry:subjectlist-measurereport.fullUrl This element must be supported. This element is included in summaries. 0..1 uri
    (NHSN-MS)
    The FHIR Logical ID for the Summary Measure Report Resource
    Bundle.Slices for entry.entry:subjectlist-measurereport.resource This element must be supported. 1..1 SubjectListMeasureReportProfile Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well
    (NHSN-MS)
    The Bundle entry for a Summary Measure Report
    Bundle.Slices for entry.entry:subjectlist-measurereport.search This element is included in summaries. C 0..1 BackboneElement Search related information
    Bundle.Slices for entry.entry:subjectlist-measurereport.search.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:subjectlist-measurereport.search.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:subjectlist-measurereport.search.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:subjectlist-measurereport.search.mode This element is included in summaries. 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.
    Bundle.Slices for entry.entry:subjectlist-measurereport.search.score This element is included in summaries. 0..1 decimal Search ranking (between 0 and 1)
    Bundle.Slices for entry.entry:subjectlist-measurereport.request This element is included in summaries. C 0..1 BackboneElement Additional execution information (transaction/batch/history)
    Bundle.Slices for entry.entry:subjectlist-measurereport.request.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:subjectlist-measurereport.request.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:subjectlist-measurereport.request.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:subjectlist-measurereport.request.method This element is included in summaries. 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
    Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
    Bundle.Slices for entry.entry:subjectlist-measurereport.request.url This element is included in summaries. 1..1 uri URL for HTTP equivalent of this entry
    Bundle.Slices for entry.entry:subjectlist-measurereport.request.ifNoneMatch This element is included in summaries. 0..1 string For managing cache currency
    Bundle.Slices for entry.entry:subjectlist-measurereport.request.ifModifiedSince This element is included in summaries. 0..1 instant For managing cache currency
    Bundle.Slices for entry.entry:subjectlist-measurereport.request.ifMatch This element is included in summaries. 0..1 string For managing update contention
    Bundle.Slices for entry.entry:subjectlist-measurereport.request.ifNoneExist This element is included in summaries. 0..1 string For conditional creates
    Bundle.Slices for entry.entry:subjectlist-measurereport.response This element is included in summaries. C 0..1 BackboneElement Results of execution (transaction/batch/history)
    Bundle.Slices for entry.entry:subjectlist-measurereport.response.id 0..1 string Unique id for inter-element referencing
    Bundle.Slices for entry.entry:subjectlist-measurereport.response.extension 0..* Extension Additional content defined by implementations
    Bundle.Slices for entry.entry:subjectlist-measurereport.response.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Bundle.Slices for entry.entry:subjectlist-measurereport.response.status This element is included in summaries. 1..1 string Status response code (text optional)
    Bundle.Slices for entry.entry:subjectlist-measurereport.response.location This element is included in summaries. 0..1 uri The location (if the operation returns a location)
    Bundle.Slices for entry.entry:subjectlist-measurereport.response.etag This element is included in summaries. 0..1 string The Etag for the resource (if relevant)
    Bundle.Slices for entry.entry:subjectlist-measurereport.response.lastModified This element is included in summaries. 0..1 instant Server's date time modified
    Bundle.Slices for entry.entry:subjectlist-measurereport.response.outcome This element is included in summaries. 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
    Bundle.signature This element is included in summaries. 0..1 Signature Digital Signature

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Bundle.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Bundle.type Base required BundleType 📍4.0.1 FHIR Std.
    Bundle.entry.search.​mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:submitting-organization.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:submitting-organization.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:submitting-device.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:submitting-device.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:poi-list.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:poi-list.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:subjectlist-measurereport.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:subjectlist-measurereport.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    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:submitting-organization, Bundle.entry:submitting-device, Bundle.entry:poi-list, Bundle.entry:subjectlist-measurereport 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:submitting-organization, Bundle.entry:submitting-device, Bundle.entry:poi-list, Bundle.entry:subjectlist-measurereport 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()

     

    Other representations of profile: CSV, Excel, Schematron